Eplan Platform API
Eplan.EplApi.DataModel Namespace / Function Class / AddArticleReference Method / AddArticleReference(String,String,UInt32) Method
article's number
article's variant number
count of articles to add

In This Topic
AddArticleReference(String,String,UInt32) Method
In This Topic
Adds a new ArticleReference to the Function.
Syntax
public virtual ArticleReference AddArticleReference( 
   string strArticleNR,
   string strVariantNR,
   uint nCount
)

Parameters

strArticleNR
article's number
strVariantNR
article's variant number
nCount
count of articles to add

Return Value

Article added to the Function
Exceptions
ExceptionDescription
Eplan.EplApi.Base.BaseExceptionThrown when the Article cannot be added
System.ArgumentNullExceptionThrown when strArticleNR is null.
System.ArgumentNullExceptionThrown when strVariantNR is null.
CannotAddArticleExceptionThrown 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 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
See Also

Reference

Function Class
Function Members
Overload List
ArticleReference Class

 

 

EPLAN API , 16.11.2024, © by EPLAN GmbH & Co. KG. All rights reserved.

Send Feedback