ISettingsManager3 Interface

Definition

Namespace:

Microsoft.VisualStudio.RpcContracts.Settings

Assembly:

Microsoft.VisualStudio.RpcContracts.dll

Package:

Microsoft.VisualStudio.RpcContracts v17.12.12

Allows read/write access to settings values and subscription to changes. Obtain this using SettingsManager.

public interface class ISettingsManager3

public interface ISettingsManager3

type ISettingsManager3 = interface

Public Interface ISettingsManager3

Methods

GetSettingInfoAsync(String, CancellationToken)	Returns the metadata for a setting. If the named setting is not registered (registration is optional), the return value will express the default metadata for settings without registration.
GetSettingInfosAsync(String, Int32, Int32, CancellationToken)	Gets the metadata for all the registered settings starting with monikerPrefix (case insensitive comparison).
GetSettingMonikersAsync(String, Int32, Int32, CancellationToken)	Gets all the registered setting monikers starting with monikerPrefix (case insensitive comparison).
GetValueAsync(String, CancellationToken)	Gets the value of a setting.
RequestChangeEventsAsync(String, CancellationToken)	Enables change events to be raised for settings matching monikerPattern (case insensitive comparison).
SetValueAsync(String, Object, CancellationToken)	Changes the value of a setting.

Events

SettingChanged

Raised when a setting has changed for settings whose name matches a pattern passed to RequestChangeEventsAsync(String, CancellationToken).