FLDget_cell_props

Synopsis

get or set the user defined properties array in one cell_set within a Cells Grid

int FLDget_cell_props (
OMobj_id cell_set,
float **props,
int *size,
int mode);

Description

FLDget_cell_props gets or sets the user defined properties array (props) in one cell_set array element within a Cells Grid.

The FLDget_cells_prop routine can be used for both getting and setting the props array. When setting with a "get" routine (mode = OM_GET_ARRAY_WR or OM_GET_ARRAY_RW), this routine returns a pointer to a pre-allocated array, and the developer just needs to fill in the values.

Parameters

OMobj_id cell_set

The OMobj_id of one cell_set array element within a Cells Grid, as returned by the OMget_cell_set routine.

float **props

Address of a pointer to a float array in which the props array is returned. Call ARRfree() on this pointer when you are done using it.

int *size

A pointer to an integer in which the size of the props array is returned.

int mode

mode sets the access mode for the array. The choices are:

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

FLDget_cell_set

FLDget_cell_nprops