Share via


IVsSettingsStore.GetBool Method

Returns a boolean type property.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assemblies:   Microsoft.VisualStudio.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)
  Microsoft.VisualStudio.Shell.Interop.10.0 (in Microsoft.VisualStudio.Shell.Interop.10.0.dll)

Syntax

'Declaration
Function GetBool ( _
    collectionPath As String, _
    propertyName As String, _
    <OutAttribute> ByRef value As Integer _
) As Integer
int GetBool(
    string collectionPath,
    string propertyName,
    out int value
)
int GetBool(
    [InAttribute] String^ collectionPath, 
    [InAttribute] String^ propertyName, 
    [OutAttribute] int% value
)
abstract GetBool : 
        collectionPath:string * 
        propertyName:string * 
        value:int byref -> int
function GetBool(
    collectionPath : String, 
    propertyName : String, 
    value : int
) : int

Parameters

  • collectionPath
    Type: String

    [in] The path of the collection.

  • propertyName
    Type: String

    [in] The property name.

  • value
    Type: Int32%

    [out] The value.

Return Value

Type: Int32
Returns S_OK if the property was returned, S_FALSE if the property does not exist or E_INVALIDARG if the property type is not boolean.

Remarks

If the property was stored as a signed or unsigned integer value, then regular C++ type-casting semantics are applied on the output value.

.NET Framework Security

See Also

Reference

IVsSettingsStore Interface

Microsoft.VisualStudio.Shell.Interop Namespace