Click or drag to resize

ISettingsProcessorDeleteGroup Method

Deletes a group and all the setting keys it contains.

Namespace: Orthogonal.NSettings
Assembly: Orthogonal.NSettings (in Orthogonal.NSettings.dll) Version: 3.0.5
Syntax
C#
bool DeleteGroup(
	Object group
)

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.

Return Value

Boolean
True if the group existed and was deleted, false otherwise.
See Also