通过

PropVariantGetStringElem 函数 (propvarutil.h)

  • 项目

从类型为 VT_LPWSTR、VT_BSTR VT_VECTOR 的 PROPVARIANT 结构中提取单个 Unicode 字符串元素 |VT_LPWSTR、VT_VECTOR |VT_BSTR或VT_ARRAY |VT_BSTR。

语法

PSSTDAPI PropVariantGetStringElem(
  [in]  REFPROPVARIANT propvar,
  [in]  ULONG          iElem,
  [out] PWSTR          *ppszVal
);

参数

[in] propvar

类型： REFPROPVARIANT

对源 PROPVARIANT 结构的引用。

[in] iElem

类型： ULONG

矢量或数组索引;否则， iElem 必须为 0。

[out] ppszVal

类型： PWSTR*

当此函数返回时，包含提取的字符串值。 当不再需要时，调用应用程序负责通过调用 CoTaskMemFree 来释放此字符串。

返回值

类型： HRESULT

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

注解

此帮助程序函数适用于以下类型的 PROPVARIANT 结构：

  • VT_LPWSTR
  • VT_BSTR
  • VT_VECTOR |VT_LPWSTR
  • VT_VECTOR |VT_BSTR
  • VT_ARRAY | VT_BSTR
如果源 PROPVARIANT 的类型VT_LPWSTR或VT_BSTR， 则 iElem 必须为 0。 否则 ，iElem 必须小于向量或数组中的元素数。 可以使用 PropVariantGetElementCount 获取向量或数组中的元素数。

如果 BSTR 元素具有 NULL 指针，则此函数分配一个空字符串。

示例

以下代码示例将作为更大的程序的一部分包含，演示如何将 PropVariantGetStringElem 与迭代语句结合使用来访问 PROPVARIANT 中的值。

// PROPVARIANT propvar;
// Assume the variable propvar is initialized and valid

if ((propvar.vt & VT_TYPEMASK) == VT_LPWSTR || (propvar.vt & VT_TYPEMASK) == VT_BSTR)
{
    UINT cElem = PropVariantGetElementCount(propvar);
    HRESULT hr = <mark type="const">S_OK</mark>;

    for (UINT iElem = 0; SUCCEEDED(hr) && iElem < cElem; iElem ++)
    {
        PWSTR pszValue;
        hr = PropVariantGetStringElem(propvar, iElem, &pszValue);

        if (SUCCEEDED(hr))
        {
            // pszValue is valid now
            CoTaskMemFree(pszValue);
        }
    }
}

要求

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

另请参阅

PropVariantGetElem