PropVariantToUInt32 函数 (propvarutil.h)

从 PROPVARIANT 结构中提取 ULONG 值。 如果无法提取任何值，则分配默认值。

语法

PSSTDAPI PropVariantToUInt32(
  [in]  REFPROPVARIANT propvarIn,
  [out] ULONG          *pulRet
);

参数

[in] propvarIn

类型： REFPROPVARIANT

对源 PROPVARIANT 结构的引用。

[out] pulRet

类型： ULONG*

当此函数返回时，包含提取的属性值（如果存在）;否则为 0。

返回值

类型： HRESULT

如果此函数成功，则返回 S_OK。 否则，将返回 HRESULT 错误代码。

注解

此帮助程序函数用于调用应用程序要求 PROPVARIANT 保存 ULONG 值的位置。 例如，从属性存储中获取值的应用程序可以使用此值安全地提取 UInt32 属性的 ULONG 值。

如果源 PROPVARIANT 的类型 VT_UI4，则此帮助程序函数将提取 ULONG 值。 否则，它会尝试将 PROPVARIANT 结构中的值转换为 ULONG。 如果无法进行转换， PropVariantToUInt32 将返回失败代码并将 pulRet 设置为 0。 有关可能转换的列表，请参阅 PropVariantChangeType 。 请注意， VT_EMPTY 已成功转换为 0。

示例

以下示例将作为较大程序的一部分包含，演示如何使用 PropVariantToUInt32 访问 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.

     // PropVariantToUInt32 will convert VT_EMPTY to 0.

     ULONG uRating;

     hr = PropVariantToUInt32(propvar, &uRating);

     if (SUCCEEDED(hr))

     {

             // uRating is now valid

     }

     else

     {

             // uRating is always 0

     }

     PropVariantClear(&propvar);

}

要求

另请参阅

InitPropVariantFromUInt32

PropVariantChangeType

PropVariantToUInt32Vector

VariantToUInt32