IVsSettingsStore.GetIntOrDefault Method

Returns an integer type property 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)

Syntax

'Declaration
Function GetIntOrDefault ( _
    collectionPath As String, _
    propertyName As String, _
    defaultValue As Integer, _
    <OutAttribute> ByRef value As Integer _
) As Integer

int GetIntOrDefault(
    string collectionPath,
    string propertyName,
    int defaultValue,
    out int value
)

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

abstract GetIntOrDefault : 
        collectionPath:string * 
        propertyName:string * 
        defaultValue:int * 
        value:int byref -> int 

function GetIntOrDefault(
    collectionPath : String, 
    propertyName : String, 
    defaultValue : int, 
    value : int
) : int

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 E_INVALIDARG() if the property type is not an integer.

Remarks

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

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

IVsSettingsStore Interface

Microsoft.VisualStudio.Shell.Interop Namespace