ISettingsReader.GetValue Method

Definition

Namespace:

Microsoft.VisualStudio.Utilities.UnifiedSettings

Assembly:

Microsoft.VisualStudio.Utilities.dll

Package:

Microsoft.VisualStudio.Utilities v17.12.40391

Overloads

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.

GetValue(String, Type, SettingReadOptions)

Gets a non-array setting's effective value, or the default value if it isn't customized.

public Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingRetrieval<object> GetValue (string moniker, Type targetType, Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingReadOptions readOptions = Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingReadOptions.RequireValidation);

abstract member GetValue : string * Type * Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingReadOptions -> Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingRetrieval<obj>

Public Function GetValue (moniker As String, targetType As Type, Optional readOptions As SettingReadOptions = Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingReadOptions.RequireValidation) As SettingRetrieval(Of Object)

Parameters

moniker

String

The moniker of the setting.

targetType

Type

The setting type.

readOptions

SettingReadOptions

Flags specifying the conditions required for success.

Returns

SettingRetrieval<Object>

An object containing the setting value if successful or error information if unsuccessful.

Exceptions

ArgumentNullException

Thrown if moniker is null.

ArgumentException

Thrown if moniker is empty.

GetValue<T>(String, SettingReadOptions)

Gets a non-array setting's effective value, or the default value if it isn't customized.

public Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingRetrieval<T> GetValue<T> (string moniker, Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingReadOptions readOptions = Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingReadOptions.RequireValidation);

abstract member GetValue : string * Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingReadOptions -> Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingRetrieval<'T>

Public Function GetValue(Of T) (moniker As String, Optional readOptions As SettingReadOptions = Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingReadOptions.RequireValidation) As SettingRetrieval(Of T)

Type Parameters

T

The setting type.

Parameters

moniker

String

The moniker of the setting.

readOptions

SettingReadOptions

Flags specifying the conditions required for success.

Returns

SettingRetrieval<T>

An object containing the setting value if successful or error information if unsuccessful.

Exceptions

ArgumentNullException

Thrown if moniker is null.

ArgumentException

Thrown if moniker is empty.