PropVariantToStringVector 函数 (propvarutil.h)

项目
03/05/2024

从 PROPVARIANT 结构中提取字符串的向量。

语法

PSSTDAPI PropVariantToStringVector(
  [in]  REFPROPVARIANT propvar,
  [out] PWSTR          *prgsz,
  [in]  ULONG          crgsz,
  [out] ULONG          *pcElem
);

参数

[in] propvar

类型： REFPROPVARIANT

对源 PROPVARIANT 结构的引用。

[out] prgsz

类型： PWSTR*

指向字符串指针向量的指针。当此函数返回时，缓冲区已使用 pcElem 元素进行初始化，这些元素指向包含从源 PROPVARIANT 提取的数据的新分配的字符串。

[in] crgsz

类型： ULONG

prgsz 指向的缓冲区的大小（在元素中）。

[out] pcElem

类型： ULONG*

当此函数返回时，包含从源 PROPVARIANT 结构中提取的字符串计数。

返回值

类型： HRESULT

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

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

注解

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

此函数适用于以下 PROPVARIANT 类型：

VT_VECTOR |VT_LPWSTR
VT_VECTOR |VT_BSTR
VT_ARRAY | VT_BSTR

如果源 PROPVARIANT 具有受支持的类型，则此帮助程序函数将提取 crgsz 字符串值，并将每个字符串值的分配副本放入 prgsz 指向的缓冲区中。如果 PROPVARIANT 包含的元素数超过 可放入 prgsz 缓冲区的元素，则此函数将返回错误并将 pcElem 设置为 0。

由于输出缓冲区所指向的每个字符串都是新分配的，因此调用应用程序负责在不再需要时使用 CoTaskMemFree 释放输出缓冲区中的每个字符串。

如果源 PROPVARIANT 中的 BSTR 为 NULL，则会将其转换为输出中包含“”的新分配的字符串。

示例

// PROPVARIANT propvar;
// Assume the variable propvar is initialized and valid
LPWSTR rgszStrings; // The application is expecting propvar to hold 4 strings in a vector
ULONG cElems;
HRESULT hr = PropVariantToStringVector(propvar, rgszStrings, ARRAYSIZE(rgszStrings), &cElems);
if (SUCCEEDED(hr))
{
     if (cElems == ARRAYSIZE(rgszStrings))
     {
         // The application got 4 string which are now stored in rgszStrings
     }
     else
     {
         // The application got cElems which are stored in the first cElems elements of rgLongs
     }
 
    // Free the cElems strings that PropVariantToStringVector allocated
    for (ULONG i = 0; i < cElems; i++)
    {
        CoTaskMemFree(rgszStrings[i]);
    }
}

要求

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