InitPropVariantFromBooleanVector function (propvarutil.h)

Article
10/13/2021

Initializes a PROPVARIANT structure from a specified Boolean vector.

Syntax

PSSTDAPI InitPropVariantFromBooleanVector(
  [in, optional] const BOOL  *prgf,
  [in]           ULONG       cElems,
  [out]          PROPVARIANT *ppropvar
);

Parameters

[in, optional] prgf

Type: const BOOL*

Pointer to the Boolean vector used to initialize the structure. If this parameter is NULL, the elements pointed to by the cabool.pElems structure member are initialized with VARIANT_FALSE.

[in] cElems

Type: ULONG

The number of vector elements.

[out] ppropvar

Type: PROPVARIANT*

When this function returns, contains the initialized PROPVARIANT structure.

Return value

Type: HRESULT

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

Remarks

This creates a VT_BOOL | VT_VECTOR propvariant.

Examples

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

PROPVARIANT propvar;
BOOL rgBool[2] = {TRUE, FALSE};

HRESULT hr = InitPropVariantFromBooleanVector(rgBool, ARRAYSIZE(rgBool), &propvar);

if (SUCCEEDED(hr))
{
    // propvar now is valid and has type VT_VECTOR | VT_BOOL.
 
    PropVariantClear(&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