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

NAME

14       gd_hidden — check whether a Dirfile entry is hidden or not
15
16

SYNOPSIS

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

DESCRIPTION

24       The  gd_hidden()  function  queries  a dirfile(5) database specified by
25       dirfile to determine whether the field or alias  called  entry_name  is
26       hidden  or not.  This information is also available in the entry object
27       proved by gd_entry(3).
28
29       By default, a hidden entry does not appear in the lists returned by the
30       functions  gd_match_entries(3),  gd_entry_list(3)  gd_constants(3),  or
31       gd_strings(3), including the special-case versions of  gd_entry_list(3)
32       such  as  gd_field_list(3).   These omissions are also reflected in the
33       counts  returned  by  the   corresponding   field   counting   function
34       gd_nentries(3) and it's special-case versions (gd_nfields(3), &c.).
35
36

RETURN VALUE

38       Upon  successful  completion,  gd_hidden()  returns one if the field or
39       alias is hidden, or zero if the entry is not hidden.
40
41       On error, it returns a negative-valued error code.  (As a  result,  the
42       caller  checking  simply  whether  the return value of this function is
43       non-zero is usually an error.)  Possible error codes are:
44
45       GD_E_BAD_CODE
46               The field specified by field_code was not found  in  the  data‐
47               base.
48
49       GD_E_BAD_DIRFILE
50               The supplied dirfile was invalid.
51
52       The  error  code  is  also  stored in the DIRFILE object and may be re‐
53       trieved after this function returns by calling gd_error(3).  A descrip‐
54       tive   error   string   for  the  error  may  be  obtained  by  calling
55       gd_error_string(3).
56
57

HISTORY

59       The gd_hidden() function appeared in GetData-0.8.0.
60
61       In GetData-0.10.0, the error return from this function changed from  -1
62       to a negative-valued error code.
63
64

SEE ALSO

66       gd_entry(3),  gd_field_list(3),  gd_hide(3), gd_nfields(3), gd_open(3),
67       gd_unhide(3), dirfile(5)
68
69
70
71Version 0.10.0                 25 December 2016                   gd_hidden(3)
Impressum