Eplan Platform API
Eplan.EplApi.DataModel Namespace / DMObjectsFinder Class / GetPotentialDefinitionsWithFilterScheme Method
Scheme-name of filter potentials-navigator

In This Topic
    GetPotentialDefinitionsWithFilterScheme Method
    In This Topic
    Returns PotentialDefinitions matching given filter from potentials-navigator.
    Syntax
    public PotentialDefinition[] GetPotentialDefinitionsWithFilterScheme( 
       string strFilterScheme
    )
    public:
    array<PotentialDefinition^>^ GetPotentialDefinitionsWithFilterScheme( 
       String^ strFilterScheme
    ) 

    Parameters

    strFilterScheme
    Scheme-name of filter potentials-navigator

    Return Value

    * 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.
    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