API Help
Eplan.EplApi.DataModel Namespace / DMObjectsFinder Class / GetCablesWithFilterScheme Method
Scheme-name of filter cables-navigator

In This Topic
GetCablesWithFilterScheme Method
In This Topic
Returns Eplan.EplApi.DataModel.EObjects.Cables and shieldings (Functions with category Shielding) matching given filter from cables-navigator.
Syntax
public Function[] GetCablesWithFilterScheme( 
   string strFilterScheme
)

Parameters

strFilterScheme
Scheme-name of filter cables-navigator

Return Value

* if scheme-name is empty, the current filter-scheme 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.
See Also

Reference

DMObjectsFinder Class
DMObjectsFinder Members
Cable Class
Function Class

 

 

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

Send Feedback