IVsSettingsReader.ReadSettingLong(String, Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 int ReadSettingLong(System::String ^ pszSettingName, [Runtime::InteropServices::Out] int % plSettingValue);

int ReadSettingLong(std::wstring const & pszSettingName, [Runtime::InteropServices::Out] int & plSettingValue);

public int ReadSettingLong (string pszSettingName, out int plSettingValue);

abstract member ReadSettingLong : string * int -> int

Public Function ReadSettingLong (pszSettingName As String, ByRef plSettingValue As Integer) As Integer

Parameters

pszSettingName: String

[in] String uniquely identifying the data element to be retrieved.

plSettingValue: Int32

[out] Long (32-bit integer) value retrieved from the specified data element of the Visual Studio settings file.

Returns

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.

Applies to