IVsSettingsReader.ReadSettingBytes(String, Byte, Int32, Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

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 values of an array stored in the Visual Studio settings file.

public:
 int ReadSettingBytes(System::String ^ pszSettingName, [Runtime::InteropServices::Out] System::Byte % pSettingValue, [Runtime::InteropServices::Out] int % plDataLength, int lDataMax);

int ReadSettingBytes(std::wstring const & pszSettingName, [Runtime::InteropServices::Out] byte & pSettingValue, [Runtime::InteropServices::Out] int & plDataLength, int lDataMax);

public int ReadSettingBytes (string pszSettingName, out byte pSettingValue, out int plDataLength, int lDataMax);

abstract member ReadSettingBytes : string * byte * int * int -> int

Public Function ReadSettingBytes (pszSettingName As String, ByRef pSettingValue As Byte, ByRef plDataLength As Integer, lDataMax As Integer) As Integer

Parameters

pszSettingName: String

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

pSettingValue: Byte

[in, out] Buffer to receive byte data retrieved from the specified data element of the Visual Studio settings file.

plDataLength: Int32

[out] Number of byte values returned.

lDataMax: Int32

[in] Maximum number of bytes to be returned. If size of the stored data is greater than lDataMax, an error is returned.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

The value of plDataLength must always be less than or equal to lDataMax.

Any buffer used to receive the retrieved data (pSettingValue) should be at least lDataMax bytes in size.

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.

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

Applies to

Поделиться через