Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Excerpt

Gets a string value from the NodeSettings dictionary by setting name.


Code Block
public string GetStringSetting(string name)

Classes: Settings


Parameters

value name

Setting name corresponding with the dictionary key inside of NodeSettings

Returns

String

A string value


Example

The following example demonstrates getting a string value from a string setting.

Code Block
var stringSetting = Settings.GetStringSetting("String Setting");

Remarks

Throws a KeyNotFoundException if no setting exists by the parameter name.

Throws an InvalidCastException if the target setting is not of SettingType.String.