PropVariantToBooleanVector 函数 (propvarutil.h)

从 PROPVARIANT 结构中提取布尔向量。

语法

PSSTDAPI PropVariantToBooleanVector(
  [in]  REFPROPVARIANT propvar,
  [out] BOOL           *prgf,
  [in]  ULONG          crgf,
  [out] ULONG          *pcElem
);

parameters

[in] propvar

类型： REFPROPVARIANT

对源 PROPVARIANT 结构的引用。

[out] prgf

类型： BOOL*

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

[in] crgf

类型： ULONG

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

[out] pcElem

类型： ULONG*

当此函数返回时，包含从源 PROPVARIANT 结构中提取的布尔元素计数。

返回值

类型： HRESULT

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

注解

当调用应用程序要求 PROPVARIANT 保存具有固定数量的元素的布尔向量值时，使用此帮助程序函数。

如果源 PROPVARIANT 的类型VT_VECTOR |VT_BOOL或VT_ARRAY |VT_BOOL，此帮助程序函数提取最大 crgf 布尔值并将其放入 prgf 指向的缓冲区中。 如果 PROPVARIANT 包含的元素多于 可放入 prgf 缓冲区的元素，则此函数将返回错误并将 pcElem 设置为 0。

示例

以下示例将作为较大程序的一部分包含，演示如何使用 PropVariantToBooleanVector 访问存储在 PROPVARIANT 中的布尔向量。

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

// The application is expecting the propvar variable to hold 4 Booleans
// in a vector.
BOOL rgFlags[4]; 
ULONG cFlags;
HRESULT hr = PropVariantToBooleanVector(propvar, rgFlags, ARRAYSIZE(rgFlags), &cFlags);

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

要求