SettingsStore.GetInt32 Method

Definition

Namespace:

Microsoft.VisualStudio.Settings

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Package:

Microsoft.VisualStudio.Shell.15.0 v17.12.40392

Overloads

GetInt32(String, String)	Returns the value of the requested property whose data type is Int32.
GetInt32(String, String, Int32)	Returns the value of the requested property whose data type is Int32.

GetInt32(String, String)

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

public:
 abstract int GetInt32(System::String ^ collectionPath, System::String ^ propertyName);

public:
 abstract int GetInt32(Platform::String ^ collectionPath, Platform::String ^ propertyName);

 abstract int GetInt32(std::wstring const & collectionPath, std::wstring const & propertyName);

public abstract int GetInt32 (string collectionPath, string propertyName);

abstract member GetInt32 : string * string -> int

Public MustOverride Function GetInt32 (collectionPath As String, propertyName As String) As Integer

Parameters

collectionPath

String

Path of the collection of the property.

propertyName

String

Name of the property.

Returns

Int32

Value of the property. If the value was stored as an unsigned integer previously then regular type conversion sematics applies.

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.

GetInt32(String, String, Int32)

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

public:
 abstract int GetInt32(System::String ^ collectionPath, System::String ^ propertyName, int defaultValue);

public:
 abstract int GetInt32(Platform::String ^ collectionPath, Platform::String ^ propertyName, int defaultValue);

 abstract int GetInt32(std::wstring const & collectionPath, std::wstring const & propertyName, int defaultValue);

public abstract int GetInt32 (string collectionPath, string propertyName, int defaultValue);

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

Public MustOverride Function GetInt32 (collectionPath As String, propertyName As String, defaultValue As Integer) As Integer

Parameters

collectionPath

String

Path of the collection of the property.

propertyName

String

Name of the property.

defaultValue

Int32

Value to be returned if the property does not exist.

Returns

Int32

If the property does not exist, it returns the defaultValue passed in. If the value was stored as an unsigned integer previously then regular type conversion sematics applies.

Exceptions

ArgumentException

Throws this exception if the property is of different type.

Remarks

This method is safe to access from any thread.