Expand Minimize

InitPropVariantFromBooleanVector function

Initializes a PROPVARIANT structure from a specified Boolean vector.

Syntax


HRESULT InitPropVariantFromBooleanVector(
  _In_opt_  const BOOL *prgf,
  _In_      ULONG cElems,
  _Out_     PROPVARIANT *ppropvar
);

Parameters

prgf [in, optional]

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.

cElems [in]

Type: ULONG

The number of vector elements.

ppropvar [out]

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

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

PropVariantToBooleanVector
InitPropVariantFromBoolean
InitVariantFromBoolean

 

 

Community Additions

ADD
Show:
© 2014 Microsoft