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_put_string(3)						      GETDATA							  gd_put_string(3)

NAME

       gd_put_string -- retrieve a string from a dirfile database

SYNOPSIS

       #include <getdata.h>

       int gd_put_string(DIRFILE *dirfile, const char *field_code, const char *data_in);

DESCRIPTION

       The gd_put_string() function queries a dirfile(5) database specified by dirfile and sets the STRING field_code , which should not contain a
       representation suffix, to the value specified in data_in.

       The dirfile argument must point to a valid DIRFILE object previously created by a call to gd_open(3).

       Because string values are stored in the dirfile metadata, the new value of field_code won't be written to disk until the  dirfile  metadata
       is flushed with gd_metaflush(3), or until the dirfile is closed.

RETURN VALUE

       On success, gd_put_string() returns the length of the string stored, including the trailing NUL character.  On error, it returns 0 and sets
       the dirfile error to a non-zero value.  Possible error values are:

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

       GD_E_BAD_DIRFILE
	       An invalid dirfile was supplied.

       GD_E_BAD_FIELD_TYPE
	       The supplied field_code referred to a field of type other than STRING.  The caller should use gd_putdata(3), or	gd_put_constant(3)
	       instead.

       GD_E_BAD_REPR
	       The representation suffix specified in field_code was not recognised.

       GD_E_BAD_TYPE
	       An invalid data_type was specified.

       GD_E_INTERNAL_ERROR
	       An  internal  error  occurred in the library while trying to perform the task.  This indicates a bug in the library.  Please report
	       the incident to the maintainer.

       GD_E_PROTECTED
	       The fragment containing the string was protected from change.

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

SEE ALSO

       dirfile(5), gd_metaflush(3), gd_open(3), gd_get_string(3), gd_error(3), gd_error_string(3), gd_putdata(3)

Version 0.7.0							    25 May 2010 						  gd_put_string(3)
Man Page