GetArticleReferencesWithFilterScheme Method

In This Topic

Returns ArticleReferences matching given filter from bill of materials-navigator.

Syntax

C#
C++/CLI

public ArticleReference[] GetArticleReferencesWithFilterScheme( 
   string strFilterScheme
)

public:
array<ArticleReference^>^ GetArticleReferencesWithFilterScheme( 
   String^ strFilterScheme
)

Parameters

strFilterScheme: Scheme-name of filter in bill of materials-navigator

Return Value

* ArticleReferences matching given ArticleReferencesFilter. * if scheme-name is empty, the current filter-scheme will be used. * if scheme-name is null, the method returns elements which are visible when no filter schema is used in a GUI navigator. * only valid ArticleReferences are returned (where ArticleReference.Count > 0 and ArticleReference.PartNr <> ""). * method doesn't return ArticleReference from ConnectionDefinitionPoint. ArticleReferences are transient objects - they are in fact on a corresponding Connection.

Exceptions

Exception	Description
Eplan.EplApi.Base.BaseException	Thrown when internal used query throw exception.
System.ArgumentException	Thrown when filter schema does not exist.
System.ArgumentNullException	Thrown if strFilterScheme is set to null.

Reference

DMObjectsFinder Class
DMObjectsFinder Members
ArticleReference Class

Send Feedback