SettingsStore.GetBoolean Method (String, String)

Returns the value of the requested property whose data type is [!:SettingsType.Int32] as boolean.

Namespace:  Microsoft.VisualStudio.Settings
Assemblies:   Microsoft.VisualStudio.Settings (in Microsoft.VisualStudio.Settings.dll)
  Microsoft.VisualStudio.Shell.11.0 (in Microsoft.VisualStudio.Shell.11.0.dll)

Syntax

'Declaration
Public MustOverride Function GetBoolean ( _
    collectionPath As String, _
    propertyName As String _
) As Boolean

public abstract bool GetBoolean(
    string collectionPath,
    string propertyName
)

public:
virtual bool GetBoolean(
    String^ collectionPath, 
    String^ propertyName
) abstract

abstract GetBoolean : 
        collectionPath:string * 
        propertyName:string -> bool

public abstract function GetBoolean(
    collectionPath : String, 
    propertyName : String
) : boolean

Parameters

• collectionPath
  Type: System.String

  Path of the collection of the property.

• propertyName
  Type: System.String

  Name of the property.

Return Value

Type: System.Boolean
If the underling integer value for the property is non-zero, it returns true and false otherwise.

Exceptions

Exception	Condition
ArgumentException	Throws this exception if the property is of different type or if it does not exist.

.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

SettingsStore Class

GetBoolean Overload

Microsoft.VisualStudio.Settings Namespace