IVsSettingsReader.ReadSettingBoolean(String, Int32) Method

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.14.40260

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.

Returns the value of a Boolean object stored in the Visual Studio settings file.

public:
 int ReadSettingBoolean(System::String ^ pszSettingName, [Runtime::InteropServices::Out] int % pfSettingValue);

int ReadSettingBoolean(std::wstring const & pszSettingName, [Runtime::InteropServices::Out] int & pfSettingValue);

public int ReadSettingBoolean(string pszSettingName, out int pfSettingValue);

abstract member ReadSettingBoolean : string * int -> int

Public Function ReadSettingBoolean (pszSettingName As String, ByRef pfSettingValue As Integer) As Integer

Parameters

pszSettingName: String

[in] String uniquely identifying the data element to be retrieved.

pfSettingValue: Int32

[out] Boolean value retrieved from the specified data element of the Visual Studio settings file.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

The names specified by pfSettingValue need to be unique within a Custom Settings Point, as the IDE uses the Custom Settings Point identifying GUID and the value of pfSettingValue to identify each saved setting.

Because the value of pfSettingValue must be unique, the order of calling ReadSettingBoolean with respect to other methods of the IVsSettingsReader interface is not relevant.

Applies to