FLDget_cell_set_user_name


Synopsis

get/set the user name for a cell_set within a Cells Grid


int FLDget_cell_set_user_name (
OMobj_id cell_set,
char *name,
int size);

int FLDset_cell_set_user_name (
OMobj_id cell_set,
const char *name);

Description

These routines get/set the user name (name) subobject within one cell_set array element in a Cells Grid.

Note: The user name (name) is any string the developer cares to use for any purpose. It is not the same as the cell_name that defines what kind of cells (Hex, Tri, etc.) make up the cell_set.

Parameters

OMobj_id cell_set

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

char *name

In FLDget_cell_set_user_name, name is a character string in which the user name is returned.

In FLDset_cell_set_user_name, name is a character string from which the user name will be copied.

int size

FLDget_cell_set_user_name only. An integer that sets the maximum length of the array to return. This is ignored if name is a NULL pointer.

Examples

modules/labels.c

Related routines