VariantToBooleanArray 函数 (propvarutil.h)

项目
03/04/2024

从 VARIANT 结构中提取布尔值的数组。

语法

PSSTDAPI VariantToBooleanArray(
  [in]  REFVARIANT var,
  [out] BOOL       *prgf,
  [in]  ULONG      crgn,
  [out] ULONG      *pcElem
);

参数

[in] var

类型： REFVARIANT

对源 VARIANT 结构的引用。

[out] prgf

类型： BOOL*

指向包含 crgn 布尔值的缓冲区的指针。当此函数返回时，缓冲区已使用从源 VARIANT 结构中提取的 *pcElemBOOL 元素初始化。

[in] crgn

类型： ULONG

prgf 指向的缓冲区中的元素数。

[out] pcElem

类型： ULONG*

当此函数返回时，包含指向从源 VARIANT 结构中提取的 BOOL 元素计数的指针。

返回值

类型： HRESULT

如果成功，则返回 S_OK ，否则返回错误值，包括：

返回代码	说明
TYPE_E_BUFFERTOOSMALL	源 VARIANT 包含的不仅仅是 crgn 值。
E_INVALIDARG	VARIANT 不是适当的类型。

注解

当调用应用程序要求 VARIANT 保存由固定数量的布尔值组成的数组时，使用此帮助程序函数。

如果源 VARIANT 的类型为 VT_ARRAY |VT_BOOL，此函数提取最多 crgnBOOL 值，并将其放入 prgf 指向的缓冲区中。如果 VARIANT 包含的元素数超过将容纳在 prgf 缓冲区中的元素，则此函数将返回一个错误并将 *pcElem 设置为 0。

示例

以下示例将作为更大的程序的一部分包含，演示如何使用 VariantToBooleanArray 访问存储在 VARIANT 结构中的 BOOL 值数组。

// VARIANT var;
// Assume variable var is initialized and valid
BOOL rgFlags[4]; // The application is expecting var to hold 4 BOOLs in an array.
ULONG cFlags;

HRESULT hr = VariantToBooleanArray(var, rgFlags, ARRAYSIZE(rgFlags), &cFlags);

if (SUCCEEDED(hr))
{
    if (cFlags == ARRAYSIZE(rgFlags))
    {
        // The application got 4 flag values which are now stored in rgFlags.
    }
    else
    {
        // The application got cFlags which are stored in the first cFlags 
        // elements of rgFlags.
    }
}

要求

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