IStoreUpdateLogger.LogSettingUpdateAsync Method

Definition

Namespace:

Microsoft.VisualStudio.Settings

Assembly:

Microsoft.VisualStudio.Utilities.dll

Package:

Microsoft.VisualStudio.Utilities v17.11.40262

Logs a record of an update to a specific setting store.

public System.Threading.Tasks.Task LogSettingUpdateAsync (string storeName, string settingName, string settingValue, bool isMachineLocal, string source = default, int? onlineRevision = default, int? localRevision = default, string listMergeBaseline = default, bool? isRoamingEnabled = default, bool? isRoamable = default);

abstract member LogSettingUpdateAsync : string * string * string * bool * string * Nullable<int> * Nullable<int> * string * Nullable<bool> * Nullable<bool> -> System.Threading.Tasks.Task

Public Function LogSettingUpdateAsync (storeName As String, settingName As String, settingValue As String, isMachineLocal As Boolean, Optional source As String = Nothing, Optional onlineRevision As Nullable(Of Integer) = Nothing, Optional localRevision As Nullable(Of Integer) = Nothing, Optional listMergeBaseline As String = Nothing, Optional isRoamingEnabled As Nullable(Of Boolean) = Nothing, Optional isRoamable As Nullable(Of Boolean) = Nothing) As Task

Parameters

storeName

String

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

settingName

String

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

settingValue

String

The full serialized value of the setting.

isMachineLocal

Boolean

A value indicating whether the setting value content is specific to this machine.

source

String

The source of the update, e.g. "ISettingsManager.SetValueAsync" or "shared store update", if known; otherwise null.

onlineRevision

Nullable<Int32>

The Azure Devops revision number associated with this value, if known; otherwise null.

localRevision

Nullable<Int32>

The local shared store revision number associated with this value, if known; otherwise null.

listMergeBaseline

String

The content of the baseline that was used in the three-way merge which produced this list value, if any; otherwise null.

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