.\" gd_protection.3. The gd_protection man page. .\" .\" Copyright (C) 2008, 2010 D. V. Wiebe .\" .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .\" .\" This file is part of the GetData project. .\" .\" Permission is granted to copy, distribute and/or modify this document .\" under the terms of the GNU Free Documentation License, Version 1.2 or .\" any later version published by the Free Software Foundation; with no .\" Invariant Sections, with no Front-Cover Texts, and with no Back-Cover .\" Texts. A copy of the license is included in the `COPYING.DOC' file .\" as part of this distribution. .\" .TH gd_protection 3 "16 July 2010" "Version 0.7.0" "GETDATA" .SH NAME gd_protection \(em report the protection level of a dirfile fragment .SH SYNOPSIS .B #include .HP .nh .ad l .BI "int gd_protection(DIRFILE *" dirfile ", int " fragment_index ); .hy .ad n .SH DESCRIPTION The .BR gd_protection () function queries a dirfile(5) database specified by .I dirfile and returns the advisory protection level for the fragment indexed by .IR fragment_index . .SH RETURN VALUE Upon successful completion, .BR gd_protection () returns the advisory protection level of the specified fragment, which will be one of the following symbols. .IP .nh .ad l .BR GD_PROTECT_NONE ,\~ GD_PROTECT_FORMAT ,\~ GD_PROTECT_DATA ,\~ .BR GD_PROTECT_ALL . .ad n .hy .PP The meaning of these symbols are explained in the .BR gd_alter_protection (3) man page. On error, it returns -1 and sets the dirfile error to a non-zero error value. Possible error values are: .TP 8 .B GD_E_BAD_DIRFILE The supplied dirfile was invalid. .TP .B GD_E_BAD_INDEX The supplied index was out of range. .PP The dirfile error may be retrieved by calling .BR gd_error (3). A descriptive error string for the last error encountered can be obtained from a call to .BR gd_error_string (3). .SH SEE ALSO .BR gd_open (3), .BR gd_alter_protection (3), .BR gd_error (3), .BR gd_error_string (3), .BR dirfile (5), .BR dirfile-format (5)