IVsSettingsReader.ReadSettingLong Method

Returns the value of a Long object stored in the Visual Studio settings file.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Syntax

'Declaración
Function ReadSettingLong ( _
    pszSettingName As String, _
    <OutAttribute> ByRef plSettingValue As Integer _
) As Integer
'Uso
Dim instance As IVsSettingsReader
Dim pszSettingName As String
Dim plSettingValue As Integer
Dim returnValue As Integer

returnValue = instance.ReadSettingLong(pszSettingName, _
    plSettingValue)

int ReadSettingLong(
    string pszSettingName,
    out int plSettingValue
)

int ReadSettingLong(
    [InAttribute] String^ pszSettingName, 
    [OutAttribute] int% plSettingValue
)

abstract ReadSettingLong : 
        pszSettingName:string * 
        plSettingValue:int byref -> int 

function ReadSettingLong(
    pszSettingName : String, 
    plSettingValue : int
) : int

Parameters

• pszSettingName
  Type: System.String
  [in] String uniquely identifying the data element to be retrieved.

• plSettingValue
  Type: System.Int32%
  [out] Long (32-bit integer) value retrieved from the specified data element of the Visual Studio settings file.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

The names specified by pfSettingValue need to be unique within a Custom Settings Point, as the IDE uses the Custom Settings Point identifying GUID and the value of pfSettingValue to identify each saved setting.

As the value of pfSettingValue must be unique, the order of calling the ReadSettingLong method with respect to other methods of the IVsSettingsReader interface is not relevant.

.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

IVsSettingsReader Interface

IVsSettingsReader Members

Microsoft.VisualStudio.Shell.Interop Namespace

IVsSettingsReader

IVsSettingsWriter

ImportSettings

Other Resources

Persisting Settings

How to: Use Interop Assemblies to Import Settings

How to: Import Settings By Using the Managed Package Framework

Visual Studio Settings