AddArticleReference(String,String,UInt32) Method

In This Topic

Adds a new ArticleReference to the Function.

Syntax

C#
C++/CLI

public override ArticleReference AddArticleReference( 
   string strArticleNr,
   string strVariantNr,
   uint nCount
)

public:
ArticleReference^ AddArticleReference( 
   String^ strArticleNr,
   String^ strVariantNr,
   uint nCount
) override

Parameters

Parameter Name	Description
strArticleNr	article's number
strVariantNr	article's variant number
nCount	count of articles to add

Return Value

ArticleReference added to the Function

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 add ArticleReference. This happens for example when 2nd ArticleReference is added to a 2D Function having ArticlePlacement category

Remarks

Stores the article from System article database in the Project. Adds the article to the Function object only if the part already exists in the system or project database. Functions of category ArticlePlacement can have only 1 ArticleReference object. In such case, when a Function is additionally 2D, its counter is adjusted to "1" value.

Reference

ConnectionDefinitionPoint Class
ConnectionDefinitionPoint Members
Overload List
ArticleReference Class

Use the Eplan Global Support Portal for feedback and support