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

NAME

14       gd_hide, gd_unhide — hide or unhide a Dirfile database entry
15
16

SYNOPSIS

18       #include <getdata.h>
19
20       int gd_hide(const DIRFILE *dirfile, const char *entry_name);
21
22       int gd_unhide(const DIRFILE *dirfile, const char *entry_name);
23
24

DESCRIPTION

26       The  gd_hide()  function  hides the field or alias called entry_name in
27       the dirfile(5) database specified by dirfile and indicates whether  the
28       field  or  alias  called  is hidden or not.  Similarly, the gd_unhide()
29       function unhides the specified entry.  An entry can also be  hidden  or
30       unhidden using gd_alter_entry(3).
31
32       By default, a hidden entry does not appear in the lists returned by the
33       functions  gd_match_entries(3),  gd_entry_list(3)  gd_constants(3),  or
34       gd_strings(3),  including the special-case versions of gd_entry_list(3)
35       such as gd_field_list(3).  These omissions are also  reflected  in  the
36       counts   returned   by   the   corresponding  field  counting  function
37       gd_nentries(3) and it's special-case versions (gd_nfields(3), &c.).
38
39

RETURN VALUE

41       Upon successful completion, gd_hide() and gd_unhide() return zero.   On
42       error,  they return a negative-valued error code.  Possible error codes
43       are:
44
45       GD_E_ACCMODE
46               The specified dirfile was opened read-only.
47
48       GD_E_BAD_CODE
49               The field specified by field_code was not found  in  the  data‐
50               base.
51
52       GD_E_BAD_DIRFILE
53               The supplied dirfile was invalid.
54
55       GD_E_PROTECTED
56               The metadata of the affected format specification fragments was
57               protected from change.
58
59       The error code is also stored in the DIRFILE  object  and  may  be  re‐
60       trieved after this function returns by calling gd_error(3).  A descrip‐
61       tive  error  string  for  the  error  may  be   obtained   by   calling
62       gd_error_string(3).
63
64

HISTORY

66       The gd_hide() and gd_unhide() functions appeared in GetData-0.8.0.
67
68       In  GetData-0.10.0,  the error return from these functions changed from
69       -1 to a negative-valued error code.
70
71

SEE ALSO

73       gd_alter_entry(3),   gd_field_list(3),   gd_hidden(3),   gd_nfields(3),
74       gd_open(3), dirfile(5)
75
76
77
78Version 0.10.0                 25 December 2016                     gd_hide(3)
Impressum