gd_entry_type man page

gd_entry_type — retrieve the type of a Dirfile field

Synopsis

#include <getdata.h>

gd_entype_t gd_entry_type(const DIRFILE *dirfile, const char *field_code);

Description

The gd_entry_type() function queries a dirfile(5) database specified by dirfile and returns the field type of the field specified by field_code. If field_code contains a valid representation suffix, it will be ignored.

The gd_entype_t type is an enumerated type which may take any of the following values:

GD_BIT_ENTRY, GD_CARRAY_ENTRY, GD_CONST_ENTRY, GD_DIVIDE_ENTRY, GD_INDEX_ENTRY, GD_INDIR_ENTRY, GD_LINCOM_ENTRY, GD_LINTERP_ENTRY, GD_MPLEX_ENTRY, GD_MULTIPLY_ENTRY, GD_PHASE_ENTRY, GD_POLYNOM_ENTRY, GD_RAW_ENTRY, GD_RECIP_ENTRY, GD_SARRAY_ENTRY, GD_SBIT_ENTRY, GD_SINDIR_ENTRY, GD_STRING_ENTRY, GD_WINDOW_ENTRY.

Return Value

Upon successful completion, gd_entry_type() returns the field type of the specified field.  On error, gd_entry_type() returns GD_NO_ENTRY and stores a negative-valued error code in the DIRFILE object which may be retrieved by a subsequent call to gd_error(3). Possible error codes are:

GD_E_BAD_DIRFILE

The supplied dirfile was invalid.

GD_E_BAD_CODE

The field specified by field_code was not found in the database.

A descriptive error string for the error may be obtained by calling gd_error_string(3).

History

The get_entry_type() function appeared in GetData-0.5.0.

In GetData-0.7.0, this function was renamed to gd_entry_type().

See Also

gd_entry(3), gd_error(3), gd_error_string(3), gd_fragmentname(3), gd_open(3), gd_parent_fragment(3), dirfile(5)

Info

25 December 2016 Version 0.10.0 GETDATA