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
Assembly:  Microsoft.VisualStudio.Shell.14.0 (in Microsoft.VisualStudio.Shell.14.0.dll)

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

Parameters

collectionPath
Type: System::String^

Path of the collection of the property.

propertyName
Type: System::String^

Name of the property.

defaultValue
Type: System::Boolean

Value 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.

Exception Condition
ArgumentException

Throws this exception if the property is of different type.

Return to top
Show: