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)

Syntax

'Declaración
Function ReadSettingBoolean ( _
    pszSettingName As String, _
    <OutAttribute> ByRef pfSettingValue As Integer _
) As Integer
'Uso
Dim instance As IVsSettingsReader
Dim pszSettingName As String
Dim pfSettingValue As Integer
Dim returnValue As Integer

returnValue = instance.ReadSettingBoolean(pszSettingName, _
    pfSettingValue)

int ReadSettingBoolean(
    string pszSettingName,
    out int pfSettingValue
)

int ReadSettingBoolean(
    [InAttribute] String^ pszSettingName, 
    [OutAttribute] int% pfSettingValue
)

abstract ReadSettingBoolean : 
        pszSettingName:string * 
        pfSettingValue:int byref -> int 

function ReadSettingBoolean(
    pszSettingName : String, 
    pfSettingValue : int
) : int

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.

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.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

IVsSettingsReader Interface

IVsSettingsReader Members

Microsoft.VisualStudio.Shell.Interop Namespace

IVsSettingsReader

IVsSettingsWriter

ImportSettings

Other Resources

Persisting Settings

How to: Use Interop Assemblies to Import Settings

How to: Import Settings By Using the Managed Package Framework

Visual Studio Settings