DDS Developers Documentation → "C" API → name


Index
cdds_addaxis
cdds_align
cdds_axis_prod
cdds_binfd
cdds_calloc
cdds_check
cdds_close
cdds_closepr
cdds_closepr2
cdds_copy
cdds_count
cdds_datadefn
cdds_dict
cdds_errors
cdds_fflush
cdds_free
cdds_genus
cdds_get
cdds_history
cdds_in
cdds_index
cdds_info
cdds_initmpi
cdds_initmpix
cdds_initopenmp
cdds_isreg
cdds_key
cdds_lseek
cdds_lseek8
cdds_malloc
cdds_map
cdds_member
cdds_memuse
cdds_mod
cdds_name
cdds_newer
cdds_next
cdds_object
cdds_offset
cdds_open
cdds_openm
cdds_openpr
cdds_out
cdds_parent
cdds_prec
cdds_prev
cdds_prime
cdds_printf
cdds_printt
cdds_printv
cdds_prtcon
cdds_prterr
cdds_prthdr
cdds_prtmsg
cdds_put
cdds_read
cdds_readm
cdds_realloc
cdds_rmaxis
cdds_savepr
cdds_scale
cdds_scanf
cdds_scank
cdds_scant
cdds_scantn
cdds_scanv
cdds_switch
cdds_write
cdds_writem
setargcv

cdds_name - query fields within DDS structures

SYNOPSIS

#include "cdds.h"

const char *cdds_name(bin_tag, field_tag);

BIN_TAG bin_tag
FIELD_TAG field_tag

DESCRIPTION

fdds_name returns the symbolic name associated with the field_tag. A NULL pointer is returned on any error.

INPUT

bin_tag is a binary tag, previously obtained from cdds_open. It specifies a particular binary stream.

field_tag is the tag of the field for which the information is desired. A value of "0" will default to the trace (SEQUENCE).

EXAMPLE

BIN_TAG bin;
FIELD_TAG tag;
int RecNum_size, prec, algn, cnt;
char *name, *genus;
...
/* byte size of RecNum field */
tag = cdds_member(bin, 0, "RecNum");
RecNum_size = cdds_prec(bin, tag);
...
/* scan trace headers */
tag = cdds_member(bin, 0, "");
while (tag)
{
   name  = cdds_name(bin, tag);
   genus = cdds_genus(bin, tag);
   prec  = cdds_prec(bin, tag);
   algn  = cdds_align(bin, tag);
   cnt   = cdds_count(bin, tag);
   ...
   tag = cdds_next(bin, tag);
}
    

SEE ALSO

cdds_member Field member tag
cdds_next Field member next tag
cdds_prev Field member previous tag
cdds_parent Field member parent tag
cdds_prime Field member prime type tag
    

AUTHOR

Jerry Ehlers, BP America (May 2003)
For additional help, open an issue here