Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

gd_dirfile_standards(3) [debian man page]

gd_dirfile_standards(3) 					      GETDATA						   gd_dirfile_standards(3)

NAME

       gd_dirfile_standards -- change or report the current Dirfile Standards Version for a DirFile

SYNOPSIS

       #include <getdata.h>

       int gd_dirfile_standards(DIRFILE *dirfile, int version );

DESCRIPTION

       The gd_dirfile_standards() version updates the current Standards Version for the open dirfile dirfile to the value specified by version, if
       possible, and then reports the current Standards Version.  Metadata written to disk for dirfile will conform to the current Standards  Ver-
       sion.

       The  Standards  Version	of  the  loaded  dirfile  also	affects  the  operation  of  functions which add fields, such as dirfile_add(3) or
       dirfile_add_spec(3); and functions which modify field metadata, such as dirfile_alter_entry(3) or dirfile_alter_spec(3).  For specific  be-
       haviour see the manual page of the appropriate function.

       The  version  parameter should be between zero and the value of the symbol GD_DIRFILE_STANDARDS_VERSION, which is the newest Standards Ver-
       sion understood by GetData, inclusive or else one of the following special symbols:

       GD_VERSION_EARLIEST
	      Specifies the current Standards Version should be set to the earliest version to which the loaded dirfile conforms.

       GD_VERSION_CURRENT
	      Specifies that the current Standards Version should not be changed.  In this case, this function simply reports  the  current  Stan-
	      dards Version.

       GD_VERSION_LATEST
	      Specifies the current Standards Version should be set to the latest version to which the loaded dirfile conforms.

       If  the	loaded dirfile does not conform to the specified version, this function fails, and the current Standards Version is unchanged.	If
       the loaded dirfile conforms to no known Standards Version, this function will fail regardless of the value  of  version	(even  if  GD_VER-
       SION_CURRENT is used).

       The caller should not assume that the loaded dirfile conforms to every Standards Version between the values reported by GD_VERSION_EARLIEST
       and GD_VERSION_LATEST.

RETURN VALUE

       On success, gd_dirfile_standards() returns the current Standards Version of the loaded dirfile, after possibly having been updated  by  the
       call.   This  will  be a number between zero and GD_DIRFILE_STANDARDS_VERSION inclusive.  On error, -1 is returned and the dirfile error is
       set to a non-zero error value, and the current Standards Version is not changed.  Possible error values are:

       GD_E_BAD_DIRFILE
	       The supplied dirfile was invalid.

       GD_E_BAD_VERSION
	       The loaded dirfile did not conform to the specified version.  Or the dirfile conforms to no known Standards Version.

       The dirfile error may be retrieved by calling gd_error(3).  A descriptive error string for the last error encountered can be obtained  from
       a call to gd_error_string(3).

NOTES

       This  function only changes the current Standards Version of the loaded dirfile.  It does not update the any format specification fragments
       on disk to conform to the specified Standards Version.  To do that, use gd_metaflush(3) or gd_rewrite_fragment(3).

SEE ALSO

       gd_open(3), gd_metaflush(3), gd_rewrite_fragment(3)

Version 0.7.0							  15 October 2010					   gd_dirfile_standards(3)

Check Out this Related Man Page

gd_alter_protection(3)						      GETDATA						    gd_alter_protection(3)

NAME

       gd_alter_protection -- modify the protection level of a dirfile fragment

SYNOPSIS

       #include <getdata.h>

       int gd_alter_protection(DIRFILE *dirfile, int protection_level, int fragment_index);

DESCRIPTION

       The  gd_alter_protection() function sets the advisory protection level of the format specification fragment given by fragment_index to pro-
       tection_level in the dirfile(5) database specified by dirfile.

       The protection_level argument should be one of the following:

       GD_PROTECT_NONE
	      Indicating that the fragment should not be protected at all.

       GD_PROTECT_FORMAT
	      Indicating that the fragment's metadata should be protected.

       GD_PROTECT_DATA
	      Indicating that the fragment's binary data should be protected.

       GD_PROTECT_ALL
	      Indicating that both the fragment's metadata and its binary data should be protected.  This symbol is equivalent to the  bitwise	or
	      of GD_PROTECT_FORMAT and GD_PROTECT_DATA.

       In addition to being simply a valid fragment index, fragment_index may also be the special value GD_ALL_FRAGMENTS, which indicates that the
       protection level of all fragments in the database should be changed.

RETURN VALUE

       Upon successful completion, gd_alter_protection() returns zero.	On error, it returns -1 and sets the dirfile error  to	a  non-zero  error
       value.  Possible error values are:

       GD_E_ACCMODE
	       The specified dirfile was opened read-only.

       GD_E_BAD_DIRFILE
	       The supplied dirfile was invalid.

       GD_E_BAD_INDEX
	       The supplied index was out of range.

       GD_E_BAD_PROTECTION
	       The supplied protection level was invalid.

       The  dirfile error may be retrieved by calling gd_error(3).  A descriptive error string for the last error encountered can be obtained from
       a call to gd_error_string(3).

NOTES

       This is the only GetData function which ignores the (existing) protection level of a format specification fragment.

SEE ALSO

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

Version 0.7.0							   21 July 2010 					    gd_alter_protection(3)
Man Page