ISettingsWriter.EnqueueChange Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| EnqueueChange<T>(String, T) |
Enqueues a change to the value of a setting. The target scope may be selected by the user during the approval process. Validation will be performed unless the setting is not registered. This is equivalent to calling EnqueueChange<T>(String, T, SettingWriteOptions) with None. |
| EnqueueChange<T>(String, T, SettingWriteOptions) |
Enqueues a change to the value of a setting. The target scope may be selected by the user during the approval process. Validation will be performed unless the setting is not registered. |
EnqueueChange<T>(String, T)
Enqueues a change to the value of a setting. The target scope may be selected by the user during the approval process. Validation will be performed unless the setting is not registered. This is equivalent to calling EnqueueChange<T>(String, T, SettingWriteOptions) with None.
public Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingChangeResult EnqueueChange<T>(string moniker, T value);abstract member EnqueueChange : string * 'T -> Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingChangeResultPublic Function EnqueueChange(Of T) (moniker As String, value As T) As SettingChangeResultType Parameters
- T
Parameters
- moniker
- String
- value
- T
The new setting value. Can be any numeric type, bool, or string. If the setting is registered, this must match the registered data type.
Returns
Exceptions
Thrown if moniker or value is null.
Thrown if moniker is empty or value is an unsupported type.
Applies to
EnqueueChange<T>(String, T, SettingWriteOptions)
Enqueues a change to the value of a setting. The target scope may be selected by the user during the approval process. Validation will be performed unless the setting is not registered.
public Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingChangeResult EnqueueChange<T>(string moniker, T value, Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingWriteOptions options);abstract member EnqueueChange : string * 'T * Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingWriteOptions -> Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingChangeResultPublic Function EnqueueChange(Of T) (moniker As String, value As T, options As SettingWriteOptions) As SettingChangeResultType Parameters
- T
Parameters
- moniker
- String
- value
- T
The new setting value. Can be any numeric type, bool, or string. If the setting is registered, this must match the registered data type.
- options
- SettingWriteOptions
Flags controlling how the change is persisted
Returns
Exceptions
Thrown if moniker or value is null.
Thrown if moniker is empty or value is an unsupported type.