ISettingsManager.GetSubset(String) Method

Definition

Namespace:

Microsoft.VisualStudio.Settings

Assembly:

Microsoft.VisualStudio.Utilities.dll

Package:

Microsoft.VisualStudio.Utilities v17.11.40262

Gets a collection representing all settings whose names match the specified pattern (either an exact match or a prefix match depending on whether the pattern ends in '*', both case-insensitive).

public:
 Microsoft::VisualStudio::Settings::ISettingsSubset ^ GetSubset(System::String ^ namePattern);

public:
 Microsoft::VisualStudio::Settings::ISettingsSubset ^ GetSubset(Platform::String ^ namePattern);

Microsoft::VisualStudio::Settings::ISettingsSubset GetSubset(std::wstring const & namePattern);

public Microsoft.VisualStudio.Settings.ISettingsSubset GetSubset (string namePattern);

abstract member GetSubset : string -> Microsoft.VisualStudio.Settings.ISettingsSubset

Public Function GetSubset (namePattern As String) As ISettingsSubset

Parameters

namePattern

String

The full name of a setting or a prefix ending in '*'. Case-insensitive.

Returns

ISettingsSubset

The settings subset.

Exceptions

ArgumentNullException

Thrown when namePattern is null.

ArgumentException

Thrown when namePattern is empty.

Remarks

This method is safe to access from any thread.