Help Center
/
Help Center›AfxNova›DVARIANT Class

DVARIANT.ToShortArraymethod

Extracts an array of Int16 values from DVARIANT.

COMmethodDVARIANT.INCdocumented

Syntax

FUNCTION ToShortArray (BYVAL prgn AS SHORT PTR, BYVAL crgn AS ULONG) AS ULONG

Parameters

NameDescription
prgnPointer to a buffer that contains crgn Int16 variables. When this function returns, the buffer has been initialized with Int16 elements extracted from DVARIANT.
crgnThe number of elements in the buffer pointed to by prgn.

Return value

The count of Int16 elements extracted from the DVARIANT.

Description

Extracts an array of Int16 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 Int16 values.

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

Reference

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