SettingsStore.GetBoolean Method (String, String, Boolean)
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, _
defaultValue As Boolean _
) As Boolean
public abstract bool GetBoolean(
string collectionPath,
string propertyName,
bool defaultValue
)
public:
virtual bool GetBoolean(
String^ collectionPath,
String^ propertyName,
bool defaultValue
) abstract
abstract GetBoolean :
collectionPath:string *
propertyName:string *
defaultValue:bool -> bool
public abstract function GetBoolean(
collectionPath : String,
propertyName : String,
defaultValue : boolean
) : boolean
Parameters
collectionPath
Type: System.StringPath of the collection of the property.
propertyName
Type: System.StringName of the property.
defaultValue
Type: System.BooleanValue to be returned if the property does not exist.
Return Value
Type: System.Boolean
If the property does not exist, it returns the defaultValue passed in otherwise it returns true if the underling integer value is non-zero and false if it is zero.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentException | Throws this exception if the property is of different type. |
.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.