Eplan Platform API
Eplan.EplApi.DataModel Namespace / DMObjectsFinder Class / GetCablesWithFilterScheme Method
Scheme name of filter fro the cable navigator

In This Topic
    GetCablesWithFilterScheme Method
    In This Topic
    Returns Eplan.EplApi.DataModel.EObjects.Cables and shieldings (Eplan.EplApi.DataModel.Functions with category "Shielding") matching the given filter from the cable navigator.
    Syntax
    public Function[] GetCablesWithFilterScheme( 
   string strFilterScheme
)
    public:
array<Function^>^ GetCablesWithFilterScheme( 
   String^ strFilterScheme
)

    Parameters

    strFilterScheme
    Scheme name of filter fro the cable navigator

    Return Value

    • If scheme name is empty, the current filter scheme 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
    ExceptionDescription
    Eplan.EplApi.Base.BaseExceptionThrown if internally used query throws exception.
    System.ArgumentExceptionThrown if filter scheme does not exist.
    System.ArgumentNullExceptionThrown if strFilterScheme is set to NULL.
    See Also

    Reference

    DMObjectsFinder Class
    DMObjectsFinder Members
    Cable Class
    Function Class

     

     

    Eplan API, 11.10.2025, © by EPLAN GmbH & Co. KG. All rights reserved.

    Use the Eplan Global Support Portal for feedback and support