PropVariantToUInt64WithDefault 函数 (propvarutil.h)

从 PROPVARIANT 结构中提取 ULONGLONG 值。 如果不存在任何值，则返回指定的默认值。

语法

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

参数

[in] propvarIn

类型： REFPROPVARIANT

对源 PROPVARIANT 结构的引用。

[in] ullDefault

类型： ULONGLONG

指定默认属性值，以便在当前不存在值的情况下使用。

返回值

类型： ULONGLONG

返回提取的无符号 LONGLONG 值，或默认值。

注解

此帮助程序函数用于调用应用程序要求 PROPVARIANT 保存 ULONGLONG 值并且希望使用默认值（如果不是）。 例如，从属性存储中获取值的应用程序可以使用此值安全地提取 UInt64 属性的 ULONGLONG 值。

如果源 PROPVARIANT 的类型 VT_UI8，则此帮助程序函数将提取 ULONGLONG 值。 否则，它会尝试将 PROPVARIANT 结构中的值转换为 ULONGLONG。 如果源 PROPVARIANT 具有 类型VT_EMPTY 或无法进行转换，则 PropVariantToUInt64WithDefault 将返回 ullDefault 提供的默认值。 有关可能转换的列表，请参阅 PropVariantChangeType 。

示例

以下示例将作为较大程序的一部分包含，演示如何使用 PropVariantToUInt64WithDefault 访问 PROPVARIANT 中的 ULONGLONG 值。

// 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);
}

要求