ISettingsRemove Method (String, NullableGuid) |
Remove the specified settings item.
It will not save the change in the database
unless you explicitly call the
Save
method.
Namespace:
AskiaPortalCmn.Common
Assembly:
AskiaPortalCmn (in AskiaPortalCmn.dll) Version: 1.7.0-build068
Syntax IReturnValue Remove(
string key,
Nullable<Guid> moduleGuid = null
)
Function Remove (
key As String,
Optional moduleGuid As Nullable(Of Guid) = Nothing
) As IReturnValue
IReturnValue^ Remove(
String^ key,
Nullable<Guid> moduleGuid = nullptr
)
Parameters
- key
- Type: SystemString
Key of the settings item to remove. - moduleGuid (Optional)
- Type: SystemNullableGuid
GUID of the module that contains the settings item.
It uses the current module
Guid
if the value is null.
Return Value
Type:
IReturnValue
It return fail value,
if the user in the context doesn't
have enough permission to do this action.
Remarks
Use this method if you want the settings
item to be inherited (if this notion is available
in the context you are).
This method could not remove inherited item,
you may have to remove the inheritance of override
the value.
It will not save the change in the database
unless you explicitly call the
Save method.
See Also