IVsSettingsStore.GetBool(String, String, Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assemblies:: Microsoft.VisualStudio.Shell.14.0.dll, Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assemblies:: Microsoft.VisualStudio.Shell.15.0.dll, Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assembly:: Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns a boolean type property.

public:
 int GetBool(System::String ^ collectionPath, System::String ^ propertyName, [Runtime::InteropServices::Out] int % value);

int GetBool(std::wstring const & collectionPath, std::wstring const & propertyName, [Runtime::InteropServices::Out] int & value);

public int GetBool (string collectionPath, string propertyName, out int value);

abstract member GetBool : string * string * int -> int

Public Function GetBool (collectionPath As String, propertyName As String, ByRef value As Integer) As Integer

Parameters

collectionPath: String

[in] The path of the collection.

propertyName: String

[in] The property name.

value: Int32

[out] The value.

Returns

Int32

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

Remarks

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

Applies to