通过

PropVariantToInt16 函数 (propvarutil.h)

  • 项目

提取 PROPVARIANT 结构的 Int16 属性值。

语法

PSSTDAPI PropVariantToInt16(
  [in]  REFPROPVARIANT propvarIn,
  [out] SHORT          *piRet
);

参数

[in] propvarIn

类型： REFPROPVARIANT

对源 PROPVARIANT 结构的引用。

[out] piRet

类型： SHORT*

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

返回值

类型： HRESULT

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

注解

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

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

示例

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

// IPropertyStore *ppropstore;

// Assume variable ppropstore is initialized and valid

PROPVARIANT propvar = {0};

HRESULT hr = ppropstore->GetValue(PKEY_Image_ResolutionUnit, &propvar);

if (SUCCEEDED(hr))

{

     // PKEY_Image_ResolutionUnit is expected to produce a VT_I2 or VT_EMPTY value.

     // PropVariantToInt16 will convert VT_EMPTY to 0.

     INT16 iUnit;

     hr = PropVariantToInt16(propvar, & iUnit);

     if (SUCCEEDED(hr))

     {

             // iUnit is now valid

     }

     else

     {

             // iUnit is always 0

     }

     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