API Help
Eplan.EplApi.DataModel Namespace / DMObjectsFinder Class / GetTerminals Method
a FunctionsFilter, can be null

In This Topic
GetTerminals Method
In This Topic
Returns Eplan.EplApi.DataModel.EObjects.Terminal matching given filter.
Syntax
public 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
ExceptionDescription
Eplan.EplApi.Base.BaseExceptionThrown 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.
See Also

Reference

DMObjectsFinder Class
DMObjectsFinder Members
Terminal Class
FunctionsFilter Class

 

 

EPLAN API , 15.12.2018, © by EPLAN Software and Service GmbH and Co. KG. All rights reserved.

Send Feedback