 | ISettingsProcessorGetDecimal(Object, Object, Decimal) Method |
Gets a decimal value (or fallback default value) from the settings, uniquely identified by the group
and key parameters.
Namespace: Orthogonal.NSettingsAssembly: Orthogonal.NSettings (in Orthogonal.NSettings.dll) Version: 3.0.5
Syntaxdecimal GetDecimal(
Object group,
Object key,
decimal fallback
)
Parameters
- group Object
-
An object that optionally provides the name of the group in which a setting key/value pair is stored.
The object value is internally converted to a group name by calling its ToString method.
A null group value may be specified which causes the setting to be placed in an unnamed group. Named groups
of settings optionally provide a convenient way of managing large numbers of settings by allowing them to be grouped
by related functionality. Settings with the same key cannot exist in the same group, but the same
key may be used in different groups. The group and key effectively form a compound key.
Do not use multiple group names that differ only by case.
Hint: It is good coding practise to specify the group as an enumerated value or a global string constant.
- key Object
-
An object that provides the name of the key under which a setting value is stored.
The object value is internally converted to a key name by calling its ToString method.
Do not use multiple key names that differ only by case.
Hint: It is good coding practise to specify the key name using the C# or Visual Basic nameof keyword.
- fallback Decimal
- A default decimal value to be returned if the setting does not exist.
Return Value
DecimalA
decimal setting value or the
fallback value if the setting does not exist.
See Also