Provided by: libgetdata-doc_0.11.0-4_all bug


       gd_hidden — check whether a Dirfile entry is hidden or not


       #include <getdata.h>

       int gd_hidden(const DIRFILE *dirfile, const char *entry_name);


       The  gd_hidden()  function queries a dirfile(5) database specified by dirfile to determine
       whether the field or alias called entry_name is hidden or not.  This information  is  also
       available in the entry object proved by gd_entry(3).

       By  default,  a  hidden  entry  does  not  appear  in  the lists returned by the functions
       gd_match_entries(3), gd_entry_list(3) gd_constants(3),  or  gd_strings(3),  including  the
       special-case  versions  of gd_entry_list(3) such as gd_field_list(3).  These omissions are
       also reflected in the  counts  returned  by  the  corresponding  field  counting  function
       gd_nentries(3) and it's special-case versions (gd_nfields(3), &c.).


       Upon  successful  completion,  gd_hidden() returns one if the field or alias is hidden, or
       zero if the entry is not hidden.

       On error, it returns a negative-valued error code.  (As  a  result,  the  caller  checking
       simply  whether  the  return  value  of  this  function  is non-zero is usually an error.)
       Possible error codes are:

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

               The supplied dirfile was invalid.

       The error code is also stored in the DIRFILE  object  and  may  be  retrieved  after  this
       function  returns by calling gd_error(3).  A descriptive error string for the error may be
       obtained by calling gd_error_string(3).


       The gd_hidden() function appeared in GetData-0.8.0.

       In GetData-0.10.0, the error return from this function changed  from  -1  to  a  negative-
       valued error code.


       gd_entry(3),   gd_field_list(3),   gd_hide(3),  gd_nfields(3),  gd_open(3),  gd_unhide(3),