1get_entry_type(3)                   GETDATA                  get_entry_type(3)
2
3
4

NAME

6       get_entry_type — retrieve the type of a dirfile field
7

SYNOPSIS

9       #include <getdata.h>
10
11       gd_entype_t get_entry_type(const DIRFILE *dirfile, const char
12              *field_code);
13

DESCRIPTION

15       The get_entry_type() function queries a dirfile(5)  database  specified
16       by  dirfile  and  returns  the  field  type  of  the field specified by
17       field_code.  If field_code contains a valid representation  suffix,  it
18       will be ignored.
19
20       The  gd_entype_t  type  is an enumerated type which may take any of the
21       following values:
22
23              GD_BIT_ENTRY, GD_CONST_ENTRY, GD_INDEX_ENTRY,
24              GD_LINCOM_ENTRY, GD_LINTERP_ENTRY, GD_MULTIPLY_ENTRY,
25              GD_PHASE_ENTRY, GD_POLYNOM_ENTRY, GD_RAW_ENTRY, GD_SBIT_ENTRY,
26              GD_STRING_ENTRY.
27

RETURN VALUE

29       Upon  successful completion, get_entry_type() returns the field type of
30       the specified field.  On error,  get_entry_type()  returns  GD_NO_ENTRY
31       and sets the dirfile error a non-zero error value.  Possible error val‐
32       ues are:
33
34       GD_E_BAD_DIRFILE
35               The supplied dirfile was invalid.
36
37       GD_E_BAD_CODE
38               The field specified by field_code was not found  in  the  data‐
39               base.
40
41       GD_E_BAD_REPR
42               The  representation  suffix  specified  in  field_code  was not
43               recognised.
44
45       The dirfile error may be retrieved by calling get_error(3).  A descrip‐
46       tive error string for the last error encountered can be obtained from a
47       call to get_error_string(3).
48
49

SEE ALSO

51       dirfile_open(3),   get_entry(3),   get_error(3),   get_error_string(3),
52       get_fragmentname(3), get_parent_fragment(3), dirfile(5)
53
54
55
56Version 0.6.0                   16 October 2009              get_entry_type(3)
Impressum