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

Статья
03/01/2024

Извлекает значение ULONG из структуры PROPVARIANT . Если не удается извлечь значение, назначается значение по умолчанию.

Синтаксис

PSSTDAPI PropVariantToUInt32(
  [in]  REFPROPVARIANT propvarIn,
  [out] ULONG          *pulRet
);

Параметры

[in] propvarIn

Тип: REFPROPVARIANT

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

[out] pulRet

Тип: ULONG*

При возврате этой функции содержит значение извлеченного свойства, если оно существует; в противном случае — 0.

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

Тип: HRESULT

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

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

Если исходный PROPVARIANT имеет тип VT_UI4, эта вспомогательская функция извлекает значение ULONG . В противном случае он пытается преобразовать значение в структуре PROPVARIANT в ULONG. Если преобразование невозможно, PropVariantToUInt32 вернет код сбоя и присвоит pulRet значение 0. Список возможных преобразований см. в разделе PropVariantChangeType . Обратите внимание, что VT_EMPTY успешно преобразуется в 0.

Примеры

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

// IPropertyStore *ppropstore;

// Assume variable ppropstore is initialized and valid

PROPVARIANT propvar = {0};

HRESULT hr = ppropstore->GetValue(PKEY_Rating, &propvar);

if (SUCCEEDED(hr))

{

     // PKEY_Rating is expected to produce a VT_UI4 or VT_EMPTY value.

     // PropVariantToUInt32 will convert VT_EMPTY to 0.

     ULONG uRating;

     hr = PropVariantToUInt32(propvar, &uRating);

     if (SUCCEEDED(hr))

     {

             // uRating is now valid

     }

     else

     {

             // uRating is always 0

     }

     PropVariantClear(&propvar);

}

Требования

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

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

InitPropVariantFromUInt32

PropVariantChangeType

PropVariantToUInt32Vector

VariantToUInt32

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