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

Статья
08/25/2023

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

Синтаксис

PSSTDAPI PropVariantToUInt64(
  [in]  REFPROPVARIANT propvarIn,
  [out] ULONGLONG      *pullRet
);

Параметры

[in] propvarIn

Тип: REFPROPVARIANT

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

[out] pullRet

Тип: ULONGLONG*

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

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

Тип: HRESULT

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

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

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

Примеры

В следующем примере, который будет включен в более крупную программу, показано, как использовать PropVariantToUInt64 для доступа к значению 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.

     // PropVariantToUInt64 will convert VT_EMPTY to 0.

     ULONGLONG ullSize;

     hr = PropVariantToUInt64(propvar, &ullSize);

     if (SUCCEEDED(hr))

     {

             // ullSize is now valid

     }

     else

     {

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