SettingsStore.GetBoolean Method

Definition

Namespace:

Microsoft.VisualStudio.Settings

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Package:

Microsoft.VisualStudio.Shell.15.0 v17.12.40392

Overloads

GetBoolean(String, String)	Returns the value of the requested property whose data type is Int32 as boolean.
GetBoolean(String, String, Boolean)	Returns the value of the requested property whose data type is Int32 as boolean.

GetBoolean(String, String)

Returns the value of the requested property whose data type is Int32 as boolean.

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

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

 abstract bool GetBoolean(std::wstring const & collectionPath, std::wstring const & propertyName);

public abstract bool GetBoolean (string collectionPath, string propertyName);

abstract member GetBoolean : string * string -> bool

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

Parameters

collectionPath

String

Path of the collection of the property.

propertyName

String

Name of the property.

Returns

Boolean

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

Exceptions

ArgumentException

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

Remarks

This method is safe to access from any thread.

GetBoolean(String, String, Boolean)

Returns the value of the requested property whose data type is Int32 as boolean.

public:
 abstract bool GetBoolean(System::String ^ collectionPath, System::String ^ propertyName, bool defaultValue);

public:
 abstract bool GetBoolean(Platform::String ^ collectionPath, Platform::String ^ propertyName, bool defaultValue);

 abstract bool GetBoolean(std::wstring const & collectionPath, std::wstring const & propertyName, bool defaultValue);

public abstract bool GetBoolean (string collectionPath, string propertyName, bool defaultValue);

abstract member GetBoolean : string * string * bool -> bool

Public MustOverride Function GetBoolean (collectionPath As String, propertyName As String, defaultValue As Boolean) As Boolean

Parameters

collectionPath

String

Path of the collection of the property.

propertyName

String

Name of the property.

defaultValue

Boolean

Value to be returned if the property does not exist.

Returns

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

ArgumentException

Throws this exception if the property is of different type.

Remarks

This method is safe to access from any thread.