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

Статья
03/01/2024

Извлекает один логический элемент из структуры PROPVARIANT типа VT_BOOL, VT_VECTOR | VT_BOOLили VT_ARRAY | VT_BOOL.

Синтаксис

PSSTDAPI PropVariantGetBooleanElem(
  [in]  REFPROPVARIANT propvar,
  [in]  ULONG          iElem,
  [out] BOOL           *pfVal
);

Параметры

[in] propvar

Тип: REFPROPVARIANT

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

[in] iElem

Тип: ULONG

Указывает индекс вектора или массива; В противном случае значение iElem должно иметь значение 0.

[out] pfVal

Тип: BOOL*

При возврате этой функцией содержит извлеченное логическое значение.

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

Тип: HRESULT

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

Если исходная структура PROPVARIANT имеет тип VT_BOOL, iElem должен иметь значение 0. В противном случае iElem должно быть меньше числа элементов в векторе или массиве. Для получения количества элементов в векторе или массиве можно использовать PropVariantGetElementCount .

В следующем примере эта функция используется для циклического просмотра значений в структуре PROPVARIANT .

Примеры

// PROPVARIANT propvar;
// assume propvar is initialized and valid

if ((propvar.vt & VT_TYPEMASK) == VT_BOOL)
{
    UINT cElem = PropVariantGetElementCount(propvar);
    HRESULT hr = <mark type="const">S_OK</mark>;
    
    for (UINT iElem = 0; SUCCEEDED(hr) && iElem < cElem; iElem ++)
    {
        BOOL fValue;
        hr = PropVariantGetBooleanElem(propvar, iElem, &fValue);
    
        if (SUCCEEDED(hr))
        {
            // fValue is valid now
        }
    }
}

Требования

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

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

PropVariantGetElem

Поделиться через