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

Статья
03/01/2024

Инициализирует структуру PROPVARIANT на основе указанного векторного элемента PROPVARIANT .

Синтаксис

PSSTDAPI InitPropVariantFromPropVariantVectorElem(
  [in]  REFPROPVARIANT propvarIn,
  [in]  ULONG          iElem,
  [out] PROPVARIANT    *ppropvar
);

Параметры

[in] propvarIn

Тип: REFPROPVARIANT

Исходная структура PROPVARIANT .

[in] iElem

Тип: ULONG

Индекс исходного элемента структуры PROPVARIANT .

[out] ppropvar

Тип: PROPVARIANT*

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

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

Тип: HRESULT

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

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

Если исходный PROPVARIANT является вектором или массивом, iElem должно быть меньше числа элементов в векторе или массиве.

Если исходный PROPVARIANT имеет одно значение, iElem должен иметь значение 0.

Если исходный PROPVARIANT пуст, эта функция всегда возвращает код ошибки.

Для получения количества элементов в векторе или массиве можно использовать PropVariantGetElementCount .

Примеры

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

// PROPVARIANT propvar;
// Assume propvar is initialized and valid.
UINT cElem = PropVariantGetElementCount(propvar);
HRESULT hr = <mark type="const">S_OK</mark>;

for (UINT iElem = 0; SUCCEEDED(hr) && iElem < cElem; iElem ++)
{
    PROPVARIANT propvarElem = {0};

    hr = InitPropVariantFromPropVariantVectorElem(propvar, iElem, &propvarElem);

    if (SUCCEEDED(hr))
    {
        // propvarElem is now valid.

        PropVariantClear(&propvarElem);
    }
}

Требования

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

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