InitVariantFromBooleanArray function

Initializes a VARIANT structure from an array of Boolean values.

Syntax


HRESULT InitVariantFromBooleanArray(
  _In_  const BOOL    *prgf,
  _In_        ULONG   cElems,
  _Out_       VARIANT *pvar
);

Parameters

prgf [in]

Type: const BOOL*

Pointer to source array of Boolean values.

cElems [in]

Type: ULONG

The number of elements in the array.

pvar [out]

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

Minimum supported client

Windows XP with SP2, Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 with SP1 [desktop apps only]

Redistributable

Windows Desktop Search (WDS) 3.0

Header

Propvarutil.h

Library

Propsys.lib

DLL

Propsys.dll (version 6.0 or later)

See also

VariantToBooleanArray
InitPropVariantFromBooleanVector

 

 

Show: