IVsSettingsStore::GetBoolOrDefault Method (String^, String^, Int32, Int32)

 

Returns a boolean type property value or a specified default value.

Namespace:   Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.10.0 (in Microsoft.VisualStudio.Shell.Interop.10.0.dll)

int GetBoolOrDefault(
	String^ collectionPath,
	String^ propertyName,
	int defaultValue,
	[OutAttribute] int% value
)

Parameters

collectionPath
Type: System::String^

[in] The path of the collection.

propertyName
Type: System::String^

[in] The property name.

defaultValue
Type: System::Int32

[in] The default value to return if the property is not set.

value
Type: System::Int32

[out] The value.

Return Value

Type: System::Int32

Returns S_OK if the property was returned, S_FALSE if the property does not exist or F:Microsoft.VisualStudio.E_INVALIDARG if the property type is not boolean.

If the property was stored as a signed or unsigned integer value, then regular C++ type casting semantics are applied on the output value.

Return to top
Show: