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

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

  • Статья

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

Синтаксис

PSSTDAPI_(ULONGLONG) PropVariantToUInt64WithDefault(
  [in] REFPROPVARIANT propvarIn,
  [in] ULONGLONG      ullDefault
);

Параметры

[in] propvarIn

Тип: REFPROPVARIANT

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

[in] ullDefault

Тип: ULONGLONG

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

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

Тип: ULONGLONG

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

Комментарии

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

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

Примеры

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

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