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

In This Topic
    GetExpandedStringSetting Method (Settings)
    In This Topic
    Returns the value of a string setting. If a setting is read that has no value for this index, the default value is returned. The index starts at 0. If this path is identified via an EPLAN path (e.g. $Eplan, $MD, ...) this identifier is resolved.
    Syntax
    public virtual string GetExpandedStringSetting( 
       string strSettingPath,
       int nIdx
    )
    public:
    virtual String^ GetExpandedStringSetting( 
       String^ strSettingPath,
       int nIdx
    ) 

    Parameters

    strSettingPath
    Indicates the path of the setting.
    nIdx
    Indicates the index.

    Return Value

    Returns the value of the setting.
    Exceptions
    ExceptionDescription
    The setting is not defined.
    Thrown when strSettingPath is null.
    Thrown when strSettingPath is empty.
    Thrown when setting path dosn't exist.
    See Also