AddStringSetting Method (ProjectSettings)

In This Topic

Defines a new setting for a string value.

Syntax

C#
C++/CLI

public void AddStringSetting( 
   string strSettingPath,
   string[] arrValues,
   string[] arrRange,
   ISettings.CreationFlag eFlag
)

public:
void AddStringSetting( 
   String^ strSettingPath,
   array<String^>^ arrValues,
   array<String^>^ arrRange,
   ISettings.CreationFlag eFlag
)

Parameters

Parameter Name	Description
strSettingPath	Indicates the path of the setting.
arrValues	Array of values added to the setting
arrRange	Ranges used for value validation.
eFlag	Eplan.EplApi.Base.ISettings.CreationFlag

Exceptions

Exception	Description
System.ArgumentNullException	Thrown when `strSettingPath` is `null`.
System.ArgumentException	Thrown when `strSettingPath` is empty.
Eplan.EplApi.Base.BaseException	Thrown when setting cannot be added.

Remarks

Default definition settings are provided for settings that use default values such as FALSE, TRUE, 0, or spaces and that do not require ranges of values.

Reference

ProjectSettings Class
ProjectSettings Members

Use the Eplan Global Support Portal for feedback and support