PropVariantToUInt16Vector 函数（propvarutil.h）

项目
07/16/2024

将数据从 PROPVARIANT 结构提取到 无符号短 向量中。

语法

PSSTDAPI PropVariantToUInt16Vector(
  [in]  REFPROPVARIANT propvar,
  [out] USHORT         *prgn,
  [in]  ULONG          crgn,
  [out] ULONG          *pcElem
);

参数

[in] propvar

类型：REFPROPVARIANT

对源 PROPVARIANT 结构的引用。

[out] prgn

类型：USHORT*

指向包含 crgn 的缓冲区，无符号短 值。当此函数返回时，缓冲区已使用 pcElem 初始化，从 source PROPVARIANT中提取的无符号短 元素。

[in] crgn

类型：ULONG

元素中指向的缓冲区的大小。

[out] pcElem

类型：ULONG*

当此函数返回时，包含从源 PROPVARIANT 结构中提取的无符号短 值的计数。

返回值

类型：HRESULT

此函数可以返回其中一个值。

返回代码	描述
S_OK	如果成功，则返回 S_OK;否则返回错误值。
TYPE_E_BUFFERTOOSMALL	源 PROPVARIANT 包含的值以上。指向的缓冲区。
E_INVALIDARG	PROPVARIANT 不是适当的类型。

言论

此帮助程序函数用于调用应用程序需要 PROPVARIANT 来保存具有固定数量的元素的无符号短值的向量。

如果源 PROPVARIANT 具有类型 VT_VECTOR | VT_UI2 或 VT_ARRAY | VT_UI2，则此帮助程序函数最多提取 无符号的短 值，并将其置于 prgn指向的缓冲区中。如果 PROPVARIANT 包含的元素数超过要适应 prgn 缓冲区的元素，则此函数将返回错误并将 pcElem 设置为 0。

例子

以下示例将作为较大程序的一部分包含在内，演示如何使用 PropVariantToUInt16Vector 访问 PROPVARIANT中 无符号的短 向量值。

// PROPVARIANT propvar;
// Assume the variable propvar is initialized and valid
USHORT rgShorts[4]; // The application is expecting propvar to hold 4 USHORTs in a vector
ULONG cElems;
HRESULT hr = PropVariantToUInt16Vector(propvar, rgShorts, ARRAYSIZE(rgShorts), &cElems);
if (SUCCEEDED(hr))
{
     if (cElems == ARRAYSIZE(rgShorts))
     {
         // The application got 4 USHORTs which are now stored in rgShorts
     }
     else
     {
         // The application got cElems which are stored in the first cElems elements of rgShorts
     }
}

要求

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