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

Статья
03/13/2024

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

Синтаксис

PSSTDAPI_(LONG) PropVariantToInt32WithDefault(
  [in] REFPROPVARIANT propvarIn,
  [in] LONG           lDefault
);

Параметры

[in] propvarIn

Тип: REFPROPVARIANT

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

[in] lDefault

Тип: LONG

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

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

Тип: LONG

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

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

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

Примеры

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

// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_FlagStatus, &propvar);
if (SUCCEEDED(hr))
{
     // PKEY_FlagStatus is expected to produce a VT_I4 or VT_EMPTY value.
     // The application developer decided to treat VT_EMPTY or invalid values as 0
     LONG iStatus = PropVariantToInt32WithDefault(propvar, 0);
     // iStatus 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

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

InitPropVariantFromInt32

PropVariantChangeType

PropVariantToInt32

VariantToInt32

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