AddArticleReference(String,String,UInt32,Boolean) Method

In This Topic

Adds a new ArticleReference to the Connection. Returns the added ArticleReference.

Syntax

C#
C++/CLI

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 Name	Description
strArticleNR	article's number
strVariantNR	article's variant number
nCount	count of articles to add
bClean	Some ArticleReferences might not be completly cleaned in the past. Setting parameter to true allows to clean ArticleReference position before inserting new one.

Return Value

ArticleReference added to the Connection

Exceptions

Exception	Description
Eplan.EplApi.Base.BaseException	Thrown when the Article cannot be added
System.ArgumentNullException	Thrown when `strArticleNR` is `null`.
System.ArgumentNullException	Thrown when `strVariantNR` is `null`.
CannotAddArticleException	Thrown when it was impossible to get valid `property index`.
FixedDeviceException	Thrown if IsFixedDevice is true.

Remarks

Stores the article from System article database in the Project. Adds the article to the Connection object only if the part already exists in the system or project database.

Reference

Connection Class
Connection Members
Overload List
ArticleReference Class

Use the Eplan Global Support Portal for feedback and support