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.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)
  Microsoft.VisualStudio.Settings (in Microsoft.VisualStudio.Settings.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: String

    Path of the collection of the property.

  • propertyName
    Type: String

    Name of the property.

Return Value

Type: 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

See Also

Reference

SettingsStore Class

GetBoolean Overload

Microsoft.VisualStudio.Settings Namespace

  • Last updated on