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

Статья
08/25/2023

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

Синтаксис

PSSTDAPI_(USHORT) PropVariantToUInt16WithDefault(
  [in] REFPROPVARIANT propvarIn,
  [in] USHORT         uiDefault
);

Параметры

[in] propvarIn

Тип: REFPROPVARIANT

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

[in] uiDefault

Тип: USHORT

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

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

Тип: unsigned short

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

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

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

Примеры

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

// IPropertyStore *ppropstore;

// Assume variable ppropstore is initialized and valid

PROPVARIANT propvar = {0};

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

if (SUCCEEDED(hr))

{

     // PKEY_FlagColor is expected to produce a VT_UI2 or VT_EMPTY value.

     // PropVariantToInt32 will convert VT_EMPTY to 0.

     USHORT uColor;

     hr = PropVariantToUInt32(propvar, & uColor);

     if (SUCCEEDED(hr))

     {

             // uColor is now valid

     }

     else

     {

             // uColor 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

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

InitPropVariantFromUInt16

PropVariantChangeType

PropVariantToUInt16Vector

VariantToUInt16

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