plucky (3) gd_unhide.3.gz

NAME

       gd_hide, gd_unhide — hide or unhide a Dirfile database entry

SYNOPSIS

       #include <getdata.h>

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

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

DESCRIPTION

       The gd_hide() function hides the field or alias called entry_name in the dirfile(5) database specified by
       dirfile and indicates whether the field or alias called is hidden or  not.   Similarly,  the  gd_unhide()
       function unhides the specified entry.  An entry can also be hidden or unhidden using gd_alter_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.).

RETURN VALUE

       Upon  successful  completion,  gd_hide()  and gd_unhide() return zero.  On error, they return a negative-
       valued error code.  Possible error codes are:

       GD_E_ACCMODE
               The specified dirfile was opened read-only.

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

       GD_E_BAD_DIRFILE
               The supplied dirfile was invalid.

       GD_E_PROTECTED
               The metadata of the affected format specification fragments was protected from change.

       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).

HISTORY

       The gd_hide() and gd_unhide() functions appeared in GetData-0.8.0.

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

SEE ALSO

       gd_alter_entry(3), gd_field_list(3), gd_hidden(3), gd_nfields(3), gd_open(3), dirfile(5)