IArraySettingMigrator.MigrateFromUnifiedSettingsAsync 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.
Writes an array setting into the legacy store at its old location and persistence format.
public System.Threading.Tasks.Task MigrateFromUnifiedSettingsAsync(string arraySettingMoniker, Microsoft.VisualStudio.Utilities.UnifiedSettings.ArraySettingContent arrayContent, System.Threading.CancellationToken cancellationToken);abstract member MigrateFromUnifiedSettingsAsync : string * Microsoft.VisualStudio.Utilities.UnifiedSettings.ArraySettingContent * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Function MigrateFromUnifiedSettingsAsync (arraySettingMoniker As String, arrayContent As ArraySettingContent, cancellationToken As CancellationToken) As TaskParameters
- arraySettingMoniker
- String
The registered moniker of the array setting
- arrayContent
- ArraySettingContent
The content of the array.
If Items is null, that means "revert to default". Otherwise, it is an ordered list of items. Each item in the array is a dictionary of item properties, with property monikers (from the array setting's registration) as keys and property values as values. If SupportsIncompleteItems(String) returns true for this setting, the property dictionaries will be missing properties that haven't been customized from their defaults.
If UserSelectedDefaultItemIndex is -1, that means "revert to default". Otherwise, it is the zero-based index of the user-selected default item.
- cancellationToken
- CancellationToken