Share via

IStoreUpdateLogger.LogSettingDeletionFailureAsync Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Settings
Assembly:
Microsoft.VisualStudio.Utilities.dll
Package:
Microsoft.VisualStudio.Utilities v17.11.40262

Logs a record of a failure to delete a specific setting from a specific store.

public System.Threading.Tasks.Task LogSettingDeletionFailureAsync (Exception exception, string storeName, string settingName, string source = default, bool? isRoamingEnabled = default, bool? isRoamable = default);
abstract member LogSettingDeletionFailureAsync : Exception * string * string * string * Nullable<bool> * Nullable<bool> -> System.Threading.Tasks.Task
Public Function LogSettingDeletionFailureAsync (exception As Exception, storeName As String, settingName As String, Optional source As String = Nothing, Optional isRoamingEnabled As Nullable(Of Boolean) = Nothing, Optional isRoamable As Nullable(Of Boolean) = Nothing) As Task

Parameters

exception
Exception
storeName
String

The name of the store being updated, e.g. "private store".

settingName
String

The full name of the setting being deleted, including an app name prefix like "Blend-" if the setting is not shared across apps.

source
String

The source of the update, e.g. "ISettingsManager.SetValueAsync" or "shared store update".

isRoamingEnabled
Nullable<Boolean>

A value indicating whether roaming is currently enabled on the machine.

isRoamable
Nullable<Boolean>

A value indicating whether the setting is registered for roaming across machines.

Returns

Task

Applies to