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
)

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

Exception	Description
Eplan.EplApi.Base.BaseException	Thrown when internal used query throw exception.
System.ArgumentException	Thrown when filter schema 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).

Send Feedback