Provided by: libgetdata-doc_0.10.0-5build2_all bug

NAME

       gd_protection — report the protection level of a Dirfile fragment

SYNOPSIS

       #include <getdata.h>

       int gd_protection(DIRFILE *dirfile, int fragment_index);

DESCRIPTION

       The  gd_protection()  function  queries  a  dirfile(5)  database  specified by dirfile and
       determines the advisory protection level for the fragment indexed by fragment_index.

RETURN VALUE

       Upon successful completion, gd_protection() returns a non-negative integer indicating  the
       the  advisory  protection level of the specified fragment.  This integer will equal one of
       the following symbols:

              GD_PROTECT_NONE, GD_PROTECT_FORMAT, GD_PROTECT_DATA, GD_PROTECT_ALL.

       The meaning of these symbols are explained in the  gd_alter_protection(3)  man  page.   On
       error, it returns a negative-valued error code.  Possible error codes are:

       GD_E_BAD_DIRFILE
               The supplied dirfile was invalid.

       GD_E_BAD_INDEX
               The supplied index was out of range.

       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 get_protection() function appeared in GetData-0.5.0.

       In GetData-0.7.0 this function was renamed to gd_protection().

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

SEE ALSO

       gd_open(3), gd_alter_protection(3), gd_error(3), gd_error_string(3), dirfile(5),  dirfile-
       format(5)