IVsSettingsReader.ReadSettingBytes(String, Byte, Int32, Int32) Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Возвращает значения массива, хранящегося в файле параметров Visual Studio.
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
Параметры
- pszSettingName
- String
[in] Строка, уникально определяющая элемент данных, который требуется извлечь.
- pSettingValue
- Byte
[вход, выход] Буфер для получения байтовых данных, полученных из указанного элемента данных в файле параметров Visual Studio.
- plDataLength
- Int32
[out] Количество возвращенных значений байтов.
- lDataMax
- Int32
[in] Максимальное число байтов, которые необходимо вернуть. Если размер сохраненных данных больше lDataMax , возвращается ошибка.
Возвращаемое значение
Если метод завершается успешно, возвращает значение S_OK. В противном случае функция возвращает код ошибки.
Комментарии
Значение plDataLength должно всегда быть меньше или равно lDataMax.
Любой буфер, используемый для получения извлеченных данных ( pSettingValue ), должен иметь lDataMax размер не менее байт.
Имена, заданные с помощью, pfSettingValue должны быть уникальными в пределах настраиваемой точки параметров, так как в интегрированной среде разработки используется настраиваемая точка параметров, идентифицирующая GUID, и значение pfSettingValue для идентификации каждого сохраненного параметра.
Поскольку значение pfSettingValue должно быть уникальным, порядок вызова ReadSettingBytes метода в отношении других методов IVsSettingsReader интерфейса не имеет значения.