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

In This Topic
    GetArticleReferencesWithFilterScheme Method
    In This Topic
    Returns Eplan.EplApi.DataModel.ArticleReferences matching the given filter from the bill of materials navigator.
    Syntax
    public ArticleReference[] GetArticleReferencesWithFilterScheme( 
       string strFilterScheme
    )
    public:
    array<ArticleReference^>^ GetArticleReferencesWithFilterScheme( 
       String^ strFilterScheme
    ) 

    Parameters

    strFilterScheme
    Scheme name of filter from the bill of materials navigator

    Return Value

    Eplan.EplApi.DataModel.ArticleReferences matching the given Eplan.EplApi.DataModel.ArticleReferencesFilter
    • If scheme name is empty, the current filter scheme will be used.
    • If scheme name is NULL, the method returns elements that are visible if no filter scheme is used in a GUI navigator.
    • Only valid ArticleReferences are returned (where ArticleReference.Count > 0 and ArticleReference.PartNr <> "").
    • This method doesn't return ArticleReference from ConnectionDefinitionPoint.
    • ArticleReferences are transient objects - they are in fact on a corresponding Connection.
    Exceptions
    ExceptionDescription
    Thrown if internally used query throws exception.
    Thrown if filter scheme does not exist.
    Thrown if strFilterScheme is set to NULL.
    See Also