FLDget_typed_node_data

Synopsis

returns an array containing the node data, converted to the desired type

Wide Version:

int FLDget_typed_node_data (field, comp, type, node_data, size, mode)(
OMobj_id field,
int comp,
int *type,
char **node_data,
xp_long *size,
int mode);

Narrow Version:

int FLDget_typed_node_data_n(field, comp, type, node_data, size, mode)
OMobj_id field;
int comp;
int *type, *size;
char **node_data;
int mode;

Description

FLDget_typed_node_data returns an array containing the node data, converted to the desired type.

Parameters

OMobj_id field

The field from which to extract the node data.

int comp

Which component to extract.

int *type

A pointer to the desired data type for node_data. You store the desired type, according to the table below, into *type. Possible values are:

Constant	Value
DTYPE_CHAR	0
DTYPE_BYTE	1
DTYPE_SHORT	2
DTYPE_INT	3
DTYPE_FLOAT	4
DTYPE_DOUBLE	5

xp_long *size
int*size

The size of the returned node_data array is returned in the int to which this parameter points.

void **cell_data

Address of a pointer to an unknown (void) type. A pointer to the node_data array is stored into *node_data. You must call ARRfree() on the resulting pointer when you are done using it.

int mode

The access mode for the node_data array:

Mode	Value	Meaning
OM_GET_ARRAY_RD	0	The program intends to read the array, but not write to it.
OM_GET_ARRAY_WR	1	The program intends to write to the array, completely replacing it, but not read it.
OM_GET_ARRAY_RW	2	The program intends to both read and write to the array.
OM_GET_ARRAY_RD_ COPY	3	The program requires a copy of the array for its own, private use (reading or writing).

Examples

none.

Files

v/fld.v.

See Also

none.