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
)

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
Eplan.EplApi.Base.BaseExceptionThrown when internal used query throw exception.
System.ArgumentExceptionThrown when filter schema does not exist.
System.ArgumentNullExceptionThrown if strFilterScheme is set to null.
Remarks
This method, unlike the GetTerminals method, returns only regular terminals (i.e. without PLC terminals).
See Also

Reference

DMObjectsFinder Class
DMObjectsFinder Members
Terminal Class

 

 

EPLAN API , 17.02.2025, © by EPLAN GmbH & Co. KG. All rights reserved.

Use the Eplan Global Support Portal for feedback and support