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

Выделяет массив значений BOOL , а затем извлекает данные из структуры VARIANT в этот массив.

Синтаксис

PSSTDAPI VariantToBooleanArrayAlloc(
  [in]  REFVARIANT var,
  [out] BOOL       **pprgf,
  [out] ULONG      *pcElem
);

Параметры

[in] var

Тип: REFVARIANT

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

[out] pprgf

Тип: BOOL**

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

[out] pcElem

Тип: ULONG*

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

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

Тип: HRESULT

Если эта функция завершается успешно, она возвращает S_OK. В противном случае возвращается код ошибки HRESULT .

Комментарии

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

Если исходный variant имеет тип VT_ARRAY | VT_BOOL эта функция извлекает массив значений BOOL в только что выделенный массив. Вызывающее приложение отвечает за использование CoTaskMemFree для освобождения массива, на который указывает pprgf , когда он больше не нужен.

Примеры

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

// VARIANT var;
// Assume variable var is initialized and valid. 
// The application expects var to contain an array of BOOL values.
BOOL *prgFlags;
ULONG cElems;

HRESULT hr = VariantToBooleanArrayAlloc(var, &prgFlags, &cElems);

if (SUCCEEDED(hr))
{
     // prgFlags now points to a vector of cElems BOOLs.
     CoTaskMemFree(prgFlags);
}

Требования

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

См. также раздел

InitVariantFromBooleanArray

PropVariantToBooleanVector

VariantToBooleanArray