Eplan Platform API
Eplan.EplApi.Base Namespace / Settings Class / GetDescription Method
Indicates the path of the setting.

In This Topic
    GetDescription Method
    In This Topic
    \Returns the description of a setting.
    Syntax
    public string GetDescription( 
       string strSettingPath
    )
    public:
    String^ GetDescription( 
       String^ strSettingPath
    ) 

    Parameters

    strSettingPath
    Indicates the path of the setting.

    Return Value

    The description of a setting as a string.
    Exceptions
    ExceptionDescription
    Thrown when strSettingPath is null.
    Thrown when strSettingPath is empty.
    The setting is not defined.
    See Also