Eplan Platform API
Eplan.EplApi.DataModel.Planning Namespace / PlanningSegment Class / AddArticleReference Method / AddArticleReference(String,String,UInt32,Boolean) Method
article's number
article's variant number
count of articles to add
Some ArticleReferences might not be completly cleaned in the past. Setting parameter to true allows to clean ArticleReference position before inserting new one.

In This Topic
    AddArticleReference(String,String,UInt32,Boolean) Method
    In This Topic
    Adds a new Eplan.EplApi.DataModel.ArticleReference to the PlanningSegment.
    Syntax
    public virtual ArticleReference AddArticleReference( 
       string strArticleNR,
       string strVariantNR,
       uint nCount,
       bool bClean
    )
    public:
    virtual ArticleReference^ AddArticleReference( 
       String^ strArticleNR,
       String^ strVariantNR,
       uint nCount,
       bool bClean
    ) 

    Parameters

    Parameter NameDescription
    strArticleNRarticle's number
    strVariantNRarticle's variant number
    nCountcount of articles to add
    bCleanSome ArticleReferences might not be completly cleaned in the past. Setting parameter to true allows to clean ArticleReference position before inserting new one.

    Return Value

    Article added to the PlanningSegment
    Exceptions
    ExceptionDescription
    Thrown when the Article cannot be added
    Thrown when strArticleNR is null.
    Thrown when strVariantNR is null.
    Thrown when there is too many article reference or IsArticleDataReadOnly is true.
    Thrown if IsFixedDevice is true.
    Remarks
    Stores the article from System article database in the Project
    See Also