ISettingsReader Interface

Definition

Namespace:

Microsoft.VisualStudio.Utilities.UnifiedSettings

Assembly:

Microsoft.VisualStudio.Utilities.dll

Package:

Microsoft.VisualStudio.Utilities v17.12.40391

This exposes the "effective value" of settings: the value from the highest priority scope where each setting is customized.

public interface ISettingsReader

type ISettingsReader = interface

Public Interface ISettingsReader

Derived

Microsoft.VisualStudio.Utilities.UnifiedSettings.ISettingsWriter

Methods

GetArray<T>(String, SettingReadOptions)	Gets an array setting's effective value, or the default value if it isn't customized.
GetArrayOrThrow<T>(String)	Gets an array setting. If there is no persisted value, the persisted value is invalid, or the persisted value can't be converted to an array of T, returns the default value.
GetValue(String, Type, SettingReadOptions)	Gets a non-array setting's effective value, or the default value if it isn't customized.
GetValue<T>(String, SettingReadOptions)	Gets a non-array setting's effective value, or the default value if it isn't customized.
GetValueOrThrow(String, Type)	Gets a non-array setting. If there is no persisted value, the persisted value is invalid, or the persisted value can't be converted to targetType, returns the default value.
GetValueOrThrow<T>(String)	Gets a non-array setting. If there is no persisted value, the persisted value is invalid, or the persisted value can't be converted to T, returns the default value.
SubscribeToChanges(Action<SettingsUpdate>, String[])	Registers a callback to be invoked when settings' effective values change. Note that a setting can change without affecting its effective value if the setting is overridden in a higher-priority scope -- e.g. if a setting change is applied to "user" scope (lower priority) but the same setting is also customized at "workspace" scope (higher priority), the change will not affect the effective value.