xHarbour Reference Documentation > Function Reference

HB_StructureToArray()

Converts values contained in a binary C structure string to an array.

Syntax

HB_StructureToArray( <cBinary>  , ;
                     <aTypes>   , ;
                    [<nAlign>]  , ;
                    [<lRecurse>], ;
                     <aStructure> ) -->  aStructure

Arguments

<cBinary>

This is a character string holding the values of structure members in binary form. It is returned from HB_ArrayToStructure().

<aTypes>

The C-data types for each structure member must be specified as a one dimensional array of the same number of elements as there are structure members. #define constants must be used for <aTypes>. The following constants are available in the Cstruct.ch file:

Constants for C-data types

Constant	C-data type
CTYPE_CHAR	char
CTYPE_UNSIGNED_CHAR	unsigned char
CTYPE_CHAR_PTR	char *
CTYPE_UNSIGNED_CHAR_PTR	unsigned char*
CTYPE_SHORT	short
CTYPE_UNSIGNED_SHORT	unsigned short
CTYPE_SHORT_PTR	short *
CTYPE_UNSIGNED_SHORT_PTR	unsigned short *
CTYPE_INT	int
CTYPE_UNSIGNED_INT	unsigned int
CTYPE_INT_PTR	int *
CTYPE_UNSIGNED_INT_PTR	unsigned int *
CTYPE_LONG	long
CTYPE_UNSIGNED_LONG	unsigned long
CTYPE_LONG_PTR	long *
CTYPE_UNSIGNED_LONG_PTR	unsigned long *
CTYPE_FLOAT	float
CTYPE_FLOAT_PTR	float *
CTYPE_DOUBLE	double
CTYPE_DOUBLE_PTR	double *
CTYPE_VOID_PTR	void *
CTYPE_STRUCTURE	struct
CTYPE_STRUCTURE_PTR	struct *

<nAlign>

Optionally, the byte alignment for C-structure members can be specified. By default, the members are aligned at an eight byte boundary. Note that Windows API functions require a four byte alignment for structures.

<lRecurse>

This parameter defaults to .F. (false). When set to .T. (true) nested structures are decoded as well.

<aStructure>

An array of Len(<aTypes>) elements must be passed to receive in its elements the decoded values of memober variables.

Return

The function returns the array <aStructure>.

Description

HB_StructureToArray() is the reverse function of HB_ArrayToStructure(). It accepts a binary character string holding structure members and decodes them from their binary representation into native xHarbour data types. The resulting values are assigned to the elements of <aStructure>.

Note:  conversion of structure data to/from binary is most comfortly done with declaring a C structure class using typedef struct and using the resulting C structure objects.

Info

See also:	C Structure class, HB_ArrayToStructure(), pragma pack(), (struct), typedef struct
Category:	C Structure support , xHarbour extensions
Header:	cstruct.ch
Source:	vm\arrayshb.c
LIB:	xhb.lib
DLL:	xhbdll.dll