Export (0) Print
Expand All

IVsSettingsReader.ReadSettingBoolean Method

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

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

int ReadSettingBoolean(
	string pszSettingName,
	out int pfSettingValue
)

Parameters

pszSettingName
Type: System.String

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

pfSettingValue
Type: System.Int32

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

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

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.

Show:
© 2014 Microsoft