Help Center

DVARIANT.ToBooleanArraymethod

Extracts an array of boolean values from DVARIANT.

COMmethodDVARIANT.INCdocumented

Syntax

FUNCTION ToBooleanArray (BYVAL prgf AS WINBOOL PTR, BYVAL crgn AS ULONG) AS ULONG

Parameters

NameDescription
prgfPointer to a buffer that contains crgn boolean values. When this function returns, the buffer has been initialized with elements extracted from the source VARIANT structure.
crgnThe number of elements in the buffer pointed to by prgf.

Return value

The count of WINBOOL elements extracted from the DVARIANT.

Description

Extracts an array of boolean values from DVARIANT.

Remarks

This helper function is used when the calling application expects a VARIANT to hold an array that consists of a fixed number of boolean values.

If the source VARIANT is of type VT_ARRAY OR VT_BOOL, this function extracts up to crgn WINBOOL values and places them into the buffer pointed to by prgf. If the VARIANT contains more elements than will fit into the prgf buffer, this function returns 0.

Reference

  • Include file DVARIANT.INC
  • Defined in AfxNova/DVARIANT.inc:1977
  • Documented in COM/DVARIANT Class.md
  • Topic: DVARIANT Class