Функция PropVariantToInt16Vector (propvarutil.h)

Статья
03/05/2024

Извлекает вектор значений Int16 из структуры PROPVARIANT .

Синтаксис

PSSTDAPI PropVariantToInt16Vector(
  [in]  REFPROPVARIANT propvar,
  [out] SHORT          *prgn,
  [in]  ULONG          crgn,
  [out] ULONG          *pcElem
);

Параметры

[in] propvar

Тип: REFPROPVARIANT

Ссылка на исходную структуру PROPVARIANT .

[out] prgn

Тип: SHORT*

Указывает на буфер, содержащий значения crgn SHORT. При возврате этой функции буфер инициализирован с помощью элементов pcElem SHORT, извлеченных из исходной структуры PROPVARIANT .

[in] crgn

Тип: ULONG

Размер буфера, на который указывает prgn в элементах.

[out] pcElem

Тип: ULONG*

При возврате этой функции содержит количество элементов Int16 , извлеченных из исходной структуры PROPVARIANT .

Возвращаемое значение

Тип: HRESULT

Эта функция может возвращать одно из этих значений.

Код возврата	Описание
S_OK	Возвращает S_OK в случае успешного выполнения или значение ошибки в противном случае.
TYPE_E_BUFFERTOOSMALL	Исходный PROPVARIANT содержал больше значений crgn . Буфер, на который указывает prgn.
E_INVALIDARG	PROPVARIANT не был соответствующего типа.

Эта вспомоганная функция используется в местах, где вызывающее приложение ожидает , что PROPVARIANT будет содержать векторное значение Int16 с фиксированным числом элементов.

Если исходный PROPVARIANT имеет тип VT_VECTOR | VT_I2 или VT_ARRAY | VT_I2 эта вспомогательская функция извлекает до значений crgn Int16 и помещает их в буфер, на который указывает prgn. Если PROPVARIANT содержит больше элементов, чем помещается в буфер prgn , эта функция возвращает ошибку и устанавливает для pcElem значение 0.

Примеры

// PROPVARIANT propvar;
// Assume the variable propvar is initialized and valid
SHORT rgShorts[4]; // The application is expecting propvar to hold 4 Int16s in a vector
ULONG cElems;
HRESULT hr = PropVariantToInt16Vector(propvar, rgShorts, ARRAYSIZE(rgShorts), &cElems);
if (SUCCEEDED(hr))
{
     if (cElems == ARRAYSIZE(rgShorts))
     {
         // The application got 4 Int16s which are now stored in rgShorts
     }
     else
     {
         // The application got cElems which are stored in the first cElems elements of rgShorts
     }
}

Требования

Требование	Значение
Минимальная версия клиента	Windows XP с пакетом обновления 2 (SP2), Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2003 с пакетом обновления 1 (SP1) [только классические приложения]
Целевая платформа	Windows
Header	propvarutil.h
Библиотека	Propsys.lib
DLL	Propsys.dll (версия 6.0 или более поздняя)
Распространяемые компоненты	Windows Desktop Search (WDS) 3.0