PropVariantToInt32Vector 函数 (propvarutil.h)

项目
03/05/2024

从 PROPVARIANT 结构中提取长值的向量。

语法

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

参数

[in] propvar

类型： REFPROPVARIANT

对源 PROPVARIANT 结构的引用。

[out] prgn

类型： LONG*

指向包含 crgnLONG 值的缓冲区。当此函数返回时，缓冲区已使用从源 PROPVARIANT 中提取的 pcElemLONG 元素进行初始化。

[in] crgn

类型： ULONG

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

[out] pcElem

类型： ULONG*

当此函数返回时，包含从源 PROPVARIANT 结构中提取的 LONG 元素的计数。

返回值

类型： HRESULT

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

返回代码	说明
S_OK	如果成功，则返回 S_OK ，否则返回错误值。
TYPE_E_BUFFERTOOSMALL	源 PROPVARIANT 包含多个 crgn 值。 prgn 指向的缓冲区。
E_INVALIDARG	PROPVARIANT 的类型不合适。

注解

此帮助程序函数用于调用应用程序要求 PROPVARIANT 保存具有固定元素数的 LONG 值的向量的位置。

如果源 PROPVARIANT 的类型 VT_VECTOR | VT_I4 或 VT_ARRAY | VT_I4，则此帮助程序函数将提取最多 crgnLONG 值并将其放入 prgn 指向的缓冲区中。如果 PROPVARIANT 包含的元素数超过 prgn 缓冲区中容纳的元素数，则此函数将返回错误并将 pcElem 设置为 0。

示例

以下示例将作为更大的程序的一部分包含，演示如何使用 PropVariantToInt32Vector 访问 PROPVARIANT 中的 Int32 矢量值。

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

要求

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