Share via


SettingsStore.GetInt32 Method (String, String, Int32)

Returns the value of the requested property whose data type is [!:SettingsType.Int32].

Namespace:  Microsoft.VisualStudio.Settings
Assemblies:   Microsoft.VisualStudio.Settings (in Microsoft.VisualStudio.Settings.dll)
  Microsoft.VisualStudio.Shell.11.0 (in Microsoft.VisualStudio.Shell.11.0.dll)

Syntax

'Declaration
Public MustOverride Function GetInt32 ( _
    collectionPath As String, _
    propertyName As String, _
    defaultValue As Integer _
) As Integer
public abstract int GetInt32(
    string collectionPath,
    string propertyName,
    int defaultValue
)
public:
virtual int GetInt32(
    String^ collectionPath, 
    String^ propertyName, 
    int defaultValue
) abstract
abstract GetInt32 : 
        collectionPath:string * 
        propertyName:string * 
        defaultValue:int -> int
public abstract function GetInt32(
    collectionPath : String, 
    propertyName : String, 
    defaultValue : int
) : int

Parameters

  • collectionPath
    Type: System.String

    Path of the collection of the property.

  • defaultValue
    Type: System.Int32

    Value to be returned if the property does not exist.

Return Value

Type: System.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 semantics apply.

Exceptions

Exception Condition
ArgumentException

Throws this exception if the property is of different type.

.NET Framework Security

See Also

Reference

SettingsStore Class

GetInt32 Overload

Microsoft.VisualStudio.Settings Namespace