1
2
3
4
5
6
7
8
9gd_entry_type(3)                    GETDATA                   gd_entry_type(3)
10
11
12

NAME

14       gd_entry_type — retrieve the type of a Dirfile field
15
16

SYNOPSIS

18       #include <getdata.h>
19
20       gd_entype_t gd_entry_type(const DIRFILE *dirfile, const char
21              *field_code);
22
23

DESCRIPTION

25       The gd_entry_type() function queries a dirfile(5) database specified by
26       dirfile   and  returns  the  field  type  of  the  field  specified  by
27       field_code.  If field_code contains a valid representation  suffix,  it
28       will be ignored.
29
30       The  gd_entype_t  type  is an enumerated type which may take any of the
31       following values:
32
33              GD_BIT_ENTRY, GD_CARRAY_ENTRY, GD_CONST_ENTRY, GD_DIVIDE_ENTRY,
34              GD_INDEX_ENTRY, GD_INDIR_ENTRY, GD_LINCOM_ENTRY,
35              GD_LINTERP_ENTRY, GD_MPLEX_ENTRY, GD_MULTIPLY_ENTRY,
36              GD_PHASE_ENTRY, GD_POLYNOM_ENTRY, GD_RAW_ENTRY, GD_RECIP_ENTRY,
37              GD_SARRAY_ENTRY, GD_SBIT_ENTRY, GD_SINDIR_ENTRY,
38              GD_STRING_ENTRY, GD_WINDOW_ENTRY.
39
40

RETURN VALUE

42       Upon  successful  completion, gd_entry_type() returns the field type of
43       the specified field.  On error, gd_entry_type() returns GD_NO_ENTRY and
44       stores  a negative-valued error code in the DIRFILE object which may be
45       retrieved by a subsequent call to gd_error(3).   Possible  error  codes
46       are:
47
48       GD_E_BAD_DIRFILE
49               The supplied dirfile was invalid.
50
51       GD_E_BAD_CODE
52               The  field  specified  by field_code was not found in the data‐
53               base.
54
55       A descriptive error string for the error may  be  obtained  by  calling
56       gd_error_string(3).
57
58

HISTORY

60       The get_entry_type() function appeared in GetData-0.5.0.
61
62       In GetData-0.7.0, this function was renamed to gd_entry_type().
63
64

SEE ALSO

66       gd_entry(3),   gd_error(3),   gd_error_string(3),   gd_fragmentname(3),
67       gd_open(3), gd_parent_fragment(3), dirfile(5)
68
69
70
71Version 0.10.0                 25 December 2016               gd_entry_type(3)
Impressum