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

Статья
03/01/2024

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

Синтаксис

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

Параметры

[in] propvar

Тип: REFPROPVARIANT

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

[out] prgn

Тип: LONG*

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

[in] crgn

Тип: ULONG

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

[out] pcElem

Тип: ULONG*

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

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

Тип: HRESULT

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

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

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

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

Примеры

В следующем примере, который будет включен в состав более крупной программы, показано, как использовать PropVariantToInt32Vector для доступа к значению вектора Int32 в PROPVARIANT.

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

Требования

Требование	Значение
Минимальная версия клиента	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