 | AzureTableSettingsDelete Method |
Deletes a setting.
Namespace: Orthogonal.NSettings.AzureTableAssembly: Orthogonal.NSettings.AzureTable (in Orthogonal.NSettings.AzureTable.dll) Version: 3.0.5
Syntaxpublic Task<bool> Delete(
Object? appKey,
Object itemKey
)
Parameters
- appKey Object
-
An object that optionally provides the application primary key part of the two-part key for a setting.
The object value is internally converted to a key string by calling its ToString method.
A null value is allowed which is suitable for settings which are not associated with any specific application
or perhaps shared between applications.
-
An application primary key can be used to partition settings into groups so they can be
more easily managed, such as listing or deleting them all at the application key level.
-
The application key is case sensitive.
-
Hint: It is good coding practise to specify the application key as an enumerated value or a global string constant.
- itemKey Object
-
An object that provides the item secondary key part of the two-part key for a setting.
The object value is internally converted to a key string by calling its ToString method.
-
The item key is case sensitive.
-
Hint: It is good coding practise to specify the item key using the C# or Visual Basic nameof operator.
Return Value
TaskBooleanA Task representing the asynchronous operation. The completed Task's
Result property contains True
if the setting was deleted. False if the setting doesn't exist.
See Also