Eplan Platform API
Eplan.EplApi.DataModel Namespace / DMObjectsFinder Class / GetTerminalsWithFilterScheme Method
Name of a filter scheme in the terminals navigator. If an empty string is passed, a filter scheme currently set in GUI 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.

In This Topic
    GetTerminalsWithFilterScheme Method
    In This Topic
    Returns Eplan.EplApi.DataModel.EObjects.Terminal matching given filter from the terminals navigator.
    Syntax
    public Terminal[] GetTerminalsWithFilterScheme( 
       string strFilterScheme
    )
    public:
    array<Terminal^>^ GetTerminalsWithFilterScheme( 
       String^ strFilterScheme
    ) 

    Parameters

    strFilterScheme
    Name of a filter scheme in the terminals navigator. If an empty string is passed, a filter scheme currently set in GUI 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.
    Remarks
    This method, unlike the GetTerminals method, returns only regular terminals (i.e. without PLC terminals).
    See Also