Share via


SettingsStore.GetUInt32 Method (String, String, UInt32)

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 GetUInt32 ( _
    collectionPath As String, _
    propertyName As String, _
    defaultValue As UInteger _
) As UInteger
public abstract uint GetUInt32(
    string collectionPath,
    string propertyName,
    uint defaultValue
)
public:
virtual unsigned int GetUInt32(
    String^ collectionPath, 
    String^ propertyName, 
    unsigned int defaultValue
) abstract
abstract GetUInt32 : 
        collectionPath:string * 
        propertyName:string * 
        defaultValue:uint32 -> uint32
public abstract function GetUInt32(
    collectionPath : String, 
    propertyName : String, 
    defaultValue : uint
) : uint

Parameters

  • collectionPath
    Type: System.String

    Path of the collection of the property.

  • defaultValue
    Type: System.UInt32

    Value to be returned if the property does not exist.

Return Value

Type: System.UInt32
If the property does not exist, it returns the defaultValue passed in. If the value was stored as a signed 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

GetUInt32 Overload

Microsoft.VisualStudio.Settings Namespace