PropVariantToUInt16 函数 (propvarutil.h)
从 PROPVARIANT 结构中提取无符号短值。 如果无法提取任何值，则分配默认值。
语法
PSSTDAPI PropVariantToUInt16(
[in] REFPROPVARIANT propvarIn,
[out] USHORT *puiRet
);
参数
[in] propvarIn
类型： REFPROPVARIANT
对源 PROPVARIANT 结构的引用。
[out] puiRet
类型： USHORT*
当此函数返回时，包含提取的属性值（如果存在）;否则为 0。
返回值
类型： HRESULT
如果此函数成功，则返回 S_OK。 否则，将返回 HRESULT 错误代码。
注解
此帮助程序函数用于调用应用程序要求 PROPVARIANT 保存 无符号短 值的位置。 例如，从属性存储中获取值的应用程序可以使用此值安全地提取 UInt16 属性的 无符号短 值。
如果源 PROPVARIANT 具有 类型VT_UI2，则此帮助程序函数将提取 无符号短 值。 否则，它会尝试将 PROPVARIANT 结构中的值转换为 USHORT。 如果无法进行转换， PropVariantToUInt16 将返回失败代码并将 puiRet 设置为 0。 有关可能转换的列表，请参阅 PropVariantChangeType 。 请注意，VT_EMPTY已成功转换为 0。
示例
以下示例将作为较大程序的一部分包含，演示如何使用 PropVariantToUInt16 访问 PROPVARIANT 中的无符号短值。
// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_FlagColor, &propvar);
if (SUCCEEDED(hr))
{
// PKEY_FlagColor is expected to produce a VT_UI2 or VT_EMPTY value.
// PropVariantToUInt16 will convert VT_EMPTY to 0.
USHORT uColor;
hr = PropVariantToUInt16(propvar, & uColor);
if (SUCCEEDED(hr))
{
// uColor is now valid
}
else
{
// uColor 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 |