PropVariantGetBooleanElem 函数 (propvarutil.h)

从 、 或 VT_ARRAY | VT_BOOL类型的 VT_BOOLVT_VECTOR | VT_BOOLPROPVARIANT 结构中提取单个布尔元素。

语法

PSSTDAPI PropVariantGetBooleanElem(
  [in]  REFPROPVARIANT propvar,
  [in]  ULONG          iElem,
  [out] BOOL           *pfVal
);

参数

[in] propvar

类型: REFPROPVARIANT

对源 PROPVARIANT 结构的引用。

[in] iElem

类型: ULONG

指定向量或数组索引;否则, iElem 必须为 0。

[out] pfVal

类型: BOOL*

当此函数返回时,包含提取的布尔值。

返回值

类型: HRESULT

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

注解

如果源 PROPVARIANT 结构的类型为 VT_BOOL则 iElem 必须为 0。 否则 ,iElem 必须小于向量或数组中的元素数。 可以使用 PropVariantGetElementCount 获取向量或数组中的元素数。

以下示例使用此函数循环访问 PROPVARIANT 结构中的值。

示例

// PROPVARIANT propvar;
// assume propvar is initialized and valid

if ((propvar.vt & VT_TYPEMASK) == VT_BOOL)
{
    UINT cElem = PropVariantGetElementCount(propvar);
    HRESULT hr = <mark type="const">S_OK</mark>;
    
    for (UINT iElem = 0; SUCCEEDED(hr) && iElem < cElem; iElem ++)
    {
        BOOL fValue;
        hr = PropVariantGetBooleanElem(propvar, iElem, &fValue);
    
        if (SUCCEEDED(hr))
        {
            // fValue is valid now
        }
    }
}

要求

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