SettingsExtensibility.ReadEffectiveValuesAsync 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
| ReadEffectiveValuesAsync(IReadOnlyCollection<Setting>, CancellationToken) |
Reads the effective values of multiple settings. |
| ReadEffectiveValuesAsync(IReadOnlyCollection<SettingCategory>, CancellationToken) |
Reads the effective values of multiple settings. |
| ReadEffectiveValuesAsync(IReadOnlyCollection<String>, CancellationToken) |
Reads the effective values of multiple settings having known setting identifiers. |
ReadEffectiveValuesAsync(IReadOnlyCollection<Setting>, CancellationToken)
Reads the effective values of multiple settings.
public System.Threading.Tasks.Task<Microsoft.VisualStudio.Extensibility.Settings.SettingValues> ReadEffectiveValuesAsync (System.Collections.Generic.IReadOnlyCollection<Microsoft.VisualStudio.Extensibility.Settings.Setting> settings, System.Threading.CancellationToken cancellationToken);member this.ReadEffectiveValuesAsync : System.Collections.Generic.IReadOnlyCollection<Microsoft.VisualStudio.Extensibility.Settings.Setting> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Extensibility.Settings.SettingValues>Public Function ReadEffectiveValuesAsync (settings As IReadOnlyCollection(Of Setting), cancellationToken As CancellationToken) As Task(Of SettingValues)Parameters
- settings
- IReadOnlyCollection<Setting>
The settings of which the values should be retrieved.
- cancellationToken
- CancellationToken
Cancellation cancellationToken for the async operation.
Returns
The current effective values of the settings, indexed by their FullId.
Remarks
The effective value of a setting is the value set in the most relevant scope in which that setting is persisted. If the setting is not persisted in any scope, the setting's default value is considered the effective value.
Applies to
ReadEffectiveValuesAsync(IReadOnlyCollection<SettingCategory>, CancellationToken)
Reads the effective values of multiple settings.
public System.Threading.Tasks.Task<Microsoft.VisualStudio.Extensibility.Settings.SettingValues> ReadEffectiveValuesAsync (System.Collections.Generic.IReadOnlyCollection<Microsoft.VisualStudio.Extensibility.Settings.SettingCategory> settingCategories, System.Threading.CancellationToken cancellationToken);member this.ReadEffectiveValuesAsync : System.Collections.Generic.IReadOnlyCollection<Microsoft.VisualStudio.Extensibility.Settings.SettingCategory> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Extensibility.Settings.SettingValues>Public Function ReadEffectiveValuesAsync (settingCategories As IReadOnlyCollection(Of SettingCategory), cancellationToken As CancellationToken) As Task(Of SettingValues)Parameters
- settingCategories
- IReadOnlyCollection<SettingCategory>
The settings categories of which the values should be retrieved.
- cancellationToken
- CancellationToken
Cancellation cancellationToken for the async operation.
Returns
The current effective values of the settings, indexed by their FullId.
Remarks
The effective value of a setting is the value set in the most relevant scope in which that setting is persisted. If the setting is not persisted in any scope, the setting's default value is considered the effective value.
Applies to
ReadEffectiveValuesAsync(IReadOnlyCollection<String>, CancellationToken)
Reads the effective values of multiple settings having known setting identifiers.
public System.Threading.Tasks.Task<Microsoft.VisualStudio.Extensibility.Settings.SettingValues> ReadEffectiveValuesAsync (System.Collections.Generic.IReadOnlyCollection<string> settingFullIdPatterns, System.Threading.CancellationToken cancellationToken);member this.ReadEffectiveValuesAsync : System.Collections.Generic.IReadOnlyCollection<string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Extensibility.Settings.SettingValues>Public Function ReadEffectiveValuesAsync (settingFullIdPatterns As IReadOnlyCollection(Of String), cancellationToken As CancellationToken) As Task(Of SettingValues)Parameters
- settingFullIdPatterns
- IReadOnlyCollection<String>
The full identifiers of the settings, including the categories they are nested under. settingFullIdPatterns can
be terminated with a single '*' character to match multiple settings the identifiers of which share a common prefix.
- cancellationToken
- CancellationToken
Cancellation cancellationToken for the async operation.
Returns
The current effective values of the requested settings.
Remarks
The effective value of a setting is the value set in the most relevant scope in which that setting is persisted. If the setting is not persisted in any scope, the setting's default value is considered the effective value.