Eplan Platform API
Eplan.EplApi.DataModel Namespace / DMObjectsFinder Class / GetArticleReferencesWithFilterScheme Method
Scheme-name of filter in bill of materials-navigator

In This Topic
    GetArticleReferencesWithFilterScheme Method
    In This Topic
    Returns ArticleReferences matching given filter from bill of materials-navigator.
    Syntax
    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
    ExceptionDescription
    Thrown when internal used query throw exception.
    Thrown when filter schema does not exist.
    Thrown if strFilterScheme is set to null.
    See Also