IVsSettingsReader::ReadSettingBytes Method (String^, Byte, Int32, Int32)
Returns the values of an array stored in the Visual Studio settings file.
Assembly: Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)
int ReadSettingBytes( String^ pszSettingName, unsigned char% pSettingValue, [OutAttribute] int% plDataLength, int lDataMax )
Parameters
- pszSettingName
-
Type:
System::String^
[in] String uniquely identifying the data element to be retrieved.
- pSettingValue
-
Type:
System::Byte
[in, out] Buffer to receive byte data retrieved from the specified data element of the Visual Studio settings file.
- plDataLength
-
Type:
System::Int32
[out] Number of byte values returned.
- lDataMax
-
Type:
System::Int32
[in] Maximum number of bytes to be returned. If size of the stored data is greater than lDataMax, an error is returned.
Return Value
Type: System::Int32If the method succeeds, it returns S_OK. If it fails, it returns an error code.
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.