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

Статья
08/25/2023

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

Синтаксис

PSSTDAPI_(ULONG) PropVariantToUInt32WithDefault(
  [in] REFPROPVARIANT propvarIn,
  [in] ULONG          ulDefault
);

Параметры

[in] propvarIn

Тип: REFPROPVARIANT

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

[in] ulDefault

Тип: ULONG

Задает значение свойства по умолчанию для использования, если значение в настоящее время не существует.

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

Тип: ULONG

Возвращает извлеченное значение ULONG или значение по умолчанию.

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

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

Примеры

В следующем примере, который будет включен в более крупную программу, показано, как использовать PropVariantToUInt32WithDefault для доступа к значению 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.
     // The application developer decided to treat VT_EMPTY or invalid values as 0
     ULONG uRating = PropVariantToUInt32WithDefault(propvar, 0);
     // uRating is now valid.
     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

PropVariantToUInt32

VariantToUInt32

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