PropVariantToInt32WithDefault 函数 (propvarutil.h)

PROPVARIANT 结构中提取 Int32 值。 如果当前不存在任何值,则返回指定的默认值。

语法

PSSTDAPI_(LONG) PropVariantToInt32WithDefault(
  [in] REFPROPVARIANT propvarIn,
  [in] LONG           lDefault
);

参数

[in] propvarIn

类型: REFPROPVARIANT

对源 PROPVARIANT 结构的引用。

[in] lDefault

类型: LONG

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

返回值

类型: LONG

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

注解

此帮助程序函数用于调用应用程序要求 PROPVARIANT 保留 LONG 值并且希望使用默认值(如果不是)的位置。 例如,从属性存储获取值的应用程序可以使用此值安全地提取 Int32 属性的 LONG 值。

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

示例

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

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

要求

要求
最低受支持的客户端 Windows XP SP2、Windows Vista [仅限桌面应用]
最低受支持的服务器 Windows Server 2003 SP1 [仅限桌面应用]
目标平台 Windows
标头 propvarutil.h
Library Propsys.lib
DLL Propsys.dll (版本 6.0 或更高版本)
可再发行组件 Windows 桌面搜索 (WDS) 3.0

另请参阅

InitPropVariantFromInt32

PropVariantChangeType

PropVariantToInt32

VariantToInt32