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

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

  • Статья

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

Синтаксис

HRESULT PropVariantGetElem(
  [in]  REFPROPVARIANT propvarIn,
  [in]  ULONG          iElem,
  [out] PROPVARIANT    *ppropvar
);

Параметры

[in] propvarIn

Тип: REFPROPVARIANT

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

[in] iElem

Тип: ULONG

Индекс элемента структуры PROPVARIANT в propvarIn.

[out] ppropvar

Тип: PROPVARIANT*

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

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

Тип: HRESULT

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

Комментарии

Эта вспомогательная функция работает для структур PROPVARIANT следующих типов:

  • VT_LPWSTR
  • VT_BSTR
  • VT_BOOL.
  • VT_I2
  • VT_I4
  • VT_I8
  • VT_U12.
  • VT_U14
  • VT_U18
  • VT_FILETIME
  • VT_VECTOR | (любой из VT_LPWSTR, VT_BSTR, VT_BOOL, VT_I2, VT_I4, VT_I8, VT_U12, VT_U14, VT_U18, VT_FILETIME)
  • VT_ARRAY | (любой из VT_BSTR, VT_BOOL, VT_I2, VT_I4, VT_I8, VT_U12, VT_U14 VT_U18)
В будущем могут поддерживаться дополнительные типы.

Это встроенная функция с исходным кодом, указанным в заголовке . Он не входит в .dll или LIB-файл.

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

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

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

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

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

Примеры

В следующем примере кода, который будет включен в более крупную программу, показано, как использовать PropVariantGetElem в операторе итерации для доступа к значениям в 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 ++)
{
   <xref rid="_stg_propvariant"/>propvarElem = {0};
    
    hr = PropVariantGetElem(propvar, iElem, &propvarElem);

    if (SUCCEEDED(hr))
    {
        // propvarElem is valid now.
        PropVariantClear(&propvarElem);
    }
}

Требования

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

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

InitPropVariantFromPropVariantVectorElem