GetTerminals Method

In This Topic

Returns Eplan.EplApi.DataModel.EObjects.Terminal matching given filter.

Syntax

C#
C++/CLI

public Terminal[] GetTerminals( 
   FunctionsFilter filter
)

public:
array<Terminal^>^ GetTerminals( 
   FunctionsFilter^ filter
)

Parameters

filter: a FunctionsFilter, can be null

Return Value

* Eplan.EplApi.DataModel.EObjects.Terminal matching given FunctionsFilter. * all Eplan.EplApi.DataModel.EObjects.Terminal when filter is null.

Exceptions

Exception	Description
Eplan.EplApi.Base.BaseException	Thrown when internal used query throw exception.

Remarks

If a 'Terminal' category is selected with the filter object, only terminals (i.e. without PLC terminals) will be returned. If a 'PLCTerminal' category is selected with the filter object, only PLC terminals will be returned. If any other category is selected with the filter object or the filter is not specified, both regular terminals and PLC terminals will be returned.

Reference

DMObjectsFinder Class
DMObjectsFinder Members
Terminal Class
FunctionsFilter Class

Send Feedback