InitVariantFromBooleanArray function (propvarutil.h)

Article
02/22/2024

Initializes a VARIANT structure from an array of Boolean values.

Syntax

PSSTDAPI InitVariantFromBooleanArray(
  [in]  const BOOL *prgf,
  [in]  ULONG      cElems,
  [out] VARIANT    *pvar
);

Parameters

[in] prgf

Type: const BOOL*

Pointer to source array of Boolean values.

[in] cElems

Type: ULONG

The number of elements in the array.

[out] pvar

Type: VARIANT*

When this function returns, contains the initialized VARIANT structure.

Return value

Type: HRESULT

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Creates a VT_ARRAY | VT_BOOL variant.

Examples

The following example, to be included as part of a larger program, demonstrates how to use InitVariantFromBooleanArray.

BOOL rgFlags[] = {TRUE, FALSE};
VARIANT var;

HRESULT hr = InitVariantFromBooleanArray(rgFlags, ARRAYSIZE(rgFlags), &var);

if (SUCCEEDED(hr))
{
    // var now is valid and has type VT_ARRAY | VT_BOOL.
    VariantClear(&propvar);
}

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP2, Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 with SP1 [desktop apps only]
Target Platform	Windows
Header	propvarutil.h
Library	Propsys.lib
DLL	Propsys.dll (version 6.0 or later)
Redistributable	Windows Desktop Search (WDS) 3.0