VariantGetBooleanElem function (propvarutil.h)

Extracts a single Boolean element from a variant structure.

Syntax

PSSTDAPI VariantGetBooleanElem(
  REFVARIANT var,
  ULONG      iElem,
  BOOL       *pfVal
);

Parameters

var

Type: REFVARIANT

Reference to a source variant structure.

iElem

Type: ULONG

Specifies vector or array index; otherwise, value must be 0.

pfVal

Type: BOOL*

Pointer to the extracted element value.

Return value

Type: HRESULT

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

Requirements

   
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