FLDset_long, FLDget

FLDset_long, FLDget_long

Synopsis

create/get/set an integer subobject to an object

int FLDset_long (
     OMobj_id field,
     const char *name,
     xp_long val);

int FLDget_long (
     OMobj_id field,
     const char *name,
     xp_ long *val);

Description

These routines add a single, new integer subobject to an existing field data schema object, and then set/get its value. They could also be used when you want to construct and reference an entirely new data object and add single integer subobjects to it, but you want to do this within the code of a function, rather than using V.

Note: If you are accessing an existing, defined subobject, use the specific routine for that subobject (for example, FLDget_coord_extent). Use FLDadd/set/get_int only when you have created your own, unique, named subobject, or when no FLD routine exists for a pre-defined subobject.

FLDadd_int adds a single integer subobject to the object specified by OMobj_id field. The object is named in the Object Manager by the string name. The new subobject is flagged as "not set."

FLDset_int sets the integer object within field, named name, to val.

FLDget_int returns the value of the integer subobject name within field in val.

Parameters

OMobj_id field

The OMobj_id of an object. This can be any object, not just a "Field".

const char *name

In FLDset_long and FLDget_long, an input character string argument that specifies which subobject of field to get/set.

xp_long val
xp_long *val

In FLDset_long, val is an input argument that sets the value of the integer subobject.

In FLDget_long, val is a pointer to an integer in which the value of the subobject is returned.

Examples

modules/pln_crop.c
modules/iso.c
modules/slice.c

Files

v/fld.v.