SettingsExtensibility.ReadEffectiveValueAsync 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
| ReadEffectiveValueAsync<T>(Setting+ObjectArray, CancellationToken) |
Reads the effective value of |
| ReadEffectiveValueAsync<T>(Setting<T>, CancellationToken) |
Reads the effective value of |
| ReadEffectiveValueAsync<T>(SettingIdentifier<T>, CancellationToken) |
Reads the effective value of a setting. |
ReadEffectiveValueAsync<T>(Setting+ObjectArray, CancellationToken)
Reads the effective value of setting.
public System.Threading.Tasks.Task<Microsoft.VisualStudio.Extensibility.Settings.SettingValue<T[]>> ReadEffectiveValueAsync<T> (Microsoft.VisualStudio.Extensibility.Settings.Setting.ObjectArray setting, System.Threading.CancellationToken cancellationToken) where T : Microsoft.VisualStudio.Extensibility.Settings.IArraySettingItemConvertible, new();member this.ReadEffectiveValueAsync : Microsoft.VisualStudio.Extensibility.Settings.Setting.ObjectArray * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Extensibility.Settings.SettingValue<'T[]>> (requires 'T :> Microsoft.VisualStudio.Extensibility.Settings.IArraySettingItemConvertible and 'T : (new : unit -> 'T))Public Function ReadEffectiveValueAsync(Of T As {IArraySettingItemConvertibleNew}) (setting As Setting.ObjectArray, cancellationToken As CancellationToken) As Task(Of SettingValue(Of T()))Type Parameters
- T
The type of the setting value.
Parameters
- setting
- Setting.ObjectArray
The setting of which the value should be retrieved.
- cancellationToken
- CancellationToken
Cancellation cancellationToken for the async operation.
Returns
The current effective value of setting.
Applies to
ReadEffectiveValueAsync<T>(Setting<T>, CancellationToken)
Reads the effective value of setting.
public System.Threading.Tasks.Task<Microsoft.VisualStudio.Extensibility.Settings.SettingValue<T>> ReadEffectiveValueAsync<T> (Microsoft.VisualStudio.Extensibility.Settings.Setting<T> setting, System.Threading.CancellationToken cancellationToken);member this.ReadEffectiveValueAsync : Microsoft.VisualStudio.Extensibility.Settings.Setting<'T> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Extensibility.Settings.SettingValue<'T>>Public Function ReadEffectiveValueAsync(Of T) (setting As Setting(Of T), cancellationToken As CancellationToken) As Task(Of SettingValue(Of T))Type Parameters
- T
The type of the setting value.
Parameters
- setting
- Setting<T>
The setting of which the value should be retrieved.
- cancellationToken
- CancellationToken
Cancellation cancellationToken for the async operation.
Returns
The current effective value of setting.
Applies to
ReadEffectiveValueAsync<T>(SettingIdentifier<T>, CancellationToken)
Reads the effective value of a setting.
public System.Threading.Tasks.Task<Microsoft.VisualStudio.Extensibility.Settings.SettingValue<T>> ReadEffectiveValueAsync<T> (Microsoft.VisualStudio.Extensibility.Settings.SettingIdentifier<T> settingId, System.Threading.CancellationToken cancellationToken);member this.ReadEffectiveValueAsync : Microsoft.VisualStudio.Extensibility.Settings.SettingIdentifier<'T> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Extensibility.Settings.SettingValue<'T>>Public Function ReadEffectiveValueAsync(Of T) (settingId As SettingIdentifier(Of T), cancellationToken As CancellationToken) As Task(Of SettingValue(Of T))Type Parameters
- T
The type of the setting value.
Parameters
- settingId
- SettingIdentifier<T>
The full identifier of the setting, including the categories it is nested under.
- cancellationToken
- CancellationToken
Cancellation cancellationToken for the async operation.
Returns
The current effective value of the setting.