InitPropVariantFromPropVariantVectorElem 函数 (propvarutil.h)

基于指定的 PROPVARIANT 向量元素初始化 PROPVARIANT 结构。

语法

PSSTDAPI InitPropVariantFromPropVariantVectorElem(
  [in]  REFPROPVARIANT propvarIn,
  [in]  ULONG          iElem,
  [out] PROPVARIANT    *ppropvar
);

参数

[in] propvarIn

类型: REFPROPVARIANT

PROPVARIANT 结构。

[in] iElem

类型: ULONG

PROPVARIANT 结构元素的索引。

[out] ppropvar

类型: PROPVARIANT*

当此函数返回时,包含初始化的 PROPVARIANT 结构。

返回值

类型: HRESULT

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

注解

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

  • VT_LPWSTR
  • VT_BSTR
  • VT_BOOL
  • VT_I2
  • VT_I4
  • VT_I8
  • VT_U12
  • VT_U14
  • VT_U18
  • VT_FILETIME
  • VT_VECTOR | (VT_LPWSTR、VT_BSTR、VT_BOOL、VT_I2、VT_I4、VT_I8、VT_U12、VT_U14、VT_U18、VT_FILETIME)
  • VT_ARRAY | (VT_BSTR、VT_BOOL、VT_I2、VT_I4、VT_I8、VT_U12、VT_U14、VT_U18)
将来可能支持其他类型。

此函数从源 PROPVARIANT 结构中提取单个值,并使用该值初始化输出 PROPVARIANT 结构。 当不再需要 ppropvar 引用的 PROPVARIANT 时,调用应用程序必须使用 PropVariantClear 释放它。

如果源 PROPVARIANT 是矢量或数组, 则 iElem 必须小于向量或数组中的元素数。

如果源 PROPVARIANT 具有单个值, 则 iElem 必须为 0。

如果源 PROPVARIANT 为空,则此函数始终返回错误代码。

可以使用 PropVariantGetElementCount 获取向量或数组中的元素数。

示例

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

// PROPVARIANT propvar;
// Assume propvar is initialized and valid.
UINT cElem = PropVariantGetElementCount(propvar);
HRESULT hr = <mark type="const">S_OK</mark>;

for (UINT iElem = 0; SUCCEEDED(hr) && iElem < cElem; iElem ++)
{
    PROPVARIANT propvarElem = {0};

    hr = InitPropVariantFromPropVariantVectorElem(propvar, iElem, &propvarElem);

    if (SUCCEEDED(hr))
    {
        // propvarElem is now valid.

        PropVariantClear(&propvarElem);
    }
}

要求

要求
最低受支持的客户端 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