PropVariantToUInt32WithDefault 函数 (propvarutil.h)

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

语法

PSSTDAPI_(ULONG) PropVariantToUInt32WithDefault(
  [in] REFPROPVARIANT propvarIn,
  [in] ULONG          ulDefault
);

参数

[in] propvarIn

类型： REFPROPVARIANT

对源 PROPVARIANT 结构的引用。

[in] ulDefault

类型： ULONG

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

返回值

类型： ULONG

返回提取的 ULONG 值或默认值。

注解

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

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

示例

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

// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_Rating, &propvar);
if (SUCCEEDED(hr))
{
     // PKEY_Rating is expected to produce a VT_UI4 or VT_EMPTY value.
     // The application developer decided to treat VT_EMPTY or invalid values as 0
     ULONG uRating = PropVariantToUInt32WithDefault(propvar, 0);
     // uRating is now valid.
     PropVariantClear(&propvar);
}

要求

另请参阅

InitPropVariantFromUInt32

PropVariantChangeType

PropVariantToUInt32

VariantToUInt32