PropVariantToInt16WithDefault 函数 (propvarutil.h)

提取 PROPVARIANT 结构的 Int16 属性值。 如果当前不存在值,则返回指定的默认值。

语法

PSSTDAPI_(SHORT) PropVariantToInt16WithDefault(
  [in] REFPROPVARIANT propvarIn,
  [in] SHORT          iDefault
);

参数

[in] propvarIn

类型: REFPROPVARIANT

对源 PROPVARIANT 结构的引用。

[in] iDefault

类型: SHORT

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

返回值

类型: SHORT

返回提取的 值或默认值。

注解

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

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

要求

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

另请参阅

InitPropVariantFromInt16

PropVariantChangeType

PropVariantToInt16

VariantToInt16