GetTerminalsWithFilterScheme Method

In This Topic

Returns Terminals matching the given filter from the terminal navigator.

Syntax

public Terminal[] GetTerminalsWithFilterScheme( 
   string strFilterScheme
)

public:
array<Terminal^>^ GetTerminalsWithFilterScheme( 
   String^ strFilterScheme
)

strFilterScheme: Scheme name of filter from the terminal 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 that are visible if no filter scheme is used in a GUI navigator.

Exceptions

Exception	Description
Eplan.EplApi.Base.BaseException	Thrown if internally used query throws exception.
System.ArgumentException	Thrown if filter scheme does not exist.
System.ArgumentNullException	Thrown if strFilterScheme is set to NULL.

Remarks

This method, unlike the GetTerminals method, returns only regular terminals (i.e. without PLC terminals).