FLDget_typed_cell_data


Synopsis

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


int FLDget_typed_cell_data(field, comp, type, cell_data, size, mode)
OMobj_id field;
int comp;
int *type, *size;
char **cell_data;
int mode;

Description

FLDget_typed_cell_data returns an array containing the cell data, converted to the desired type.

Parameters

OMobj_id field

The field from which to extract the cell data.

int comp

Which component to extract.

int *type

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

 

int *size

The size of the returned cell_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 cell_data array is stored into *cell_data. You must call ARRfree() on the resulting pointer when you are done using it.

int mode

The access mode for the cell_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).

 

 

Example

None available.

Related routines

Not applicable.