ISettingsReader.GetArray<T>(String, SettingReadOptions) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Utilities.UnifiedSettings

Assembly:: Microsoft.VisualStudio.Utilities.dll

Package:: Microsoft.VisualStudio.Utilities v17.13.40008

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingRetrieval<System.Collections.Generic.IReadOnlyList<T>> GetArray<T> (string moniker, Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingReadOptions readOptions = Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingReadOptions.RequireValidation);

abstract member GetArray : string * Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingReadOptions -> Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingRetrieval<System.Collections.Generic.IReadOnlyList<'T>>

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

Type Parameters

T

The array element type. This can be a simple type like string/int or a caller-defined class with properties.

Parameters

moniker: String

The moniker of the array setting.

readOptions: SettingReadOptions

Flags specifying the conditions required for success.

Returns

SettingRetrieval<IReadOnlyList<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.

Applies to

Share via