get_protection (3) - Linux Manuals

get_protection: report the protection level of a dirfile fragment

Command to display get_protection manual in Linux: $ man 3 get_protection

NAME

get_protection --- report the protection level of a dirfile fragment

SYNOPSIS

#include <getdata.h>

int get_protection(DIRFILE *dirfile, int fragment_index);

DESCRIPTION

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

RETURN VALUE

Upon successful completion, get_protection() returns the advisory protection level of the specified fragment, which will be 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 dirfile_protect(3) man page. On error, it returns -1 and sets the dirfile error to a non-zero error value. Possible error values are:
GD_E_BAD_DIRFILE: The supplied dirfile was invalid.
GD_E_BAD_INDEX: The supplied index was out of range. The dirfile error may be retrieved by calling get_error(3). A descriptive error string for the last error encountered can be obtained from a call to get_error_string(3).