gd_bof(3) [debian man page]

gd_bof(3)							      GETDATA								 gd_bof(3)

NAME

       gd_bof -- report the start of data in a field

SYNOPSIS

       #include <getdata.h>

       off_t gd_bof(DIRFILE *dirfile, const char *field_code);

DESCRIPTION

       The gd_bof() function queries a dirfile(5) database specified by dirfile and returns the sample number of the beginning-of-field marker for
       the vector field given by field_code.

       The caller should not assume that the beginning-of-field marker falls on a frame boundary.  The beginning-of-field marker  is  never  nega-
       tive.

       For  a RAW field, the beginning-of-field corresponds to the frame offset of that field (see gd_frameoffset(3)).	The beginning-of-field for
       all other vector field type is the same as the beginning-of-field of whichever of its input fields that starts latest.	The  beginning-of-
       field marker for the special field INDEX is always zero.

       The beginning-of-field marker for a field containing no data is in the same location as, or after, its end-of-field marker (see gd_eof(3)).
       For a RAW field, the difference between the locations of the beginning- and end-of-field markers indicates the number of  samples  of  data
       actually stored on disk.

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

RETURN VALUE

       Upon successful completion, gd_bof() returns the sample number of the end-of-field marker for the indicated field.  On error, it returns -1
       and sets the dirfile error to a non-zero error value.  Possible error values are:

       GD_E_BAD_CODE
	       The field specified by field_code or one of the fields it uses as input was not found in the database.

       GD_E_BAD_DIRFILE
	       The supplied dirfile was invalid.

       GD_E_BAD_REPR
	       The representation suffix specified in field_code, or in one of its inputs was not recognised.

       GD_E_DIMENSION
	       A scalar field was found where a vector field was expected in the definition of field_code or one of its inputs, or else field_code
	       itself specified a scalar field.

       GD_E_RECURSE_LEVEL
	       Too  many levels of recursion were encountered while trying to resolve field_code.  This usually indicates a circular dependency in
	       field specification in the dirfile.

       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).

SEE ALSO

       dirfile(5), dirfile-encoding(5), gd_open(3), gd_eof(3), gd_error(3), gd_error_string(3), gd_nframes(3)

Version 0.7.0							  15 October 2010							 gd_bof(3)

gd_rename(3)							      GETDATA							      gd_rename(3)

NAME

       gd_rename -- change the name of a dirfile field

SYNOPSIS

       #include <getdata.h>

       int gd_rename(DIRFILE *dirfile, const char *old_code, const char *new_name, int move_data);

DESCRIPTION

       The  gd_rename() function changes the name of the field specified by old_code, which should not contain a representation suffix, defined in
       the dirfile specified by dirfile to new_name.  If the new name is the same as the old name, this function does nothing.

       When renaming a metafield, the metafield should be specified in old_code by its full (slashed) field code, while new_name should only  con-
       tain the new name (without slash).

       If  the	flag move_data is non-zero, and old_code specifies a RAW field, the binary file associated with the field will be renamed as well.
       If move_data is zero, no changes will be made to the binary file.  If field_code specifies a field of type other than  RAW,  the  move_data
       flag is ignored.

RETURN VALUE

       On  success,  gd_rename()  returns  zero.  On error, -1 is returned and the dirfile error is set to a non-zero error value.  Possible error
       values are:

       GD_E_ACCMODE
	       The specified dirfile was opened read-only.

       GD_E_ALLOC
	       The library was unable to allocate memory.

       GD_E_BAD_CODE
	       The field specified by old_code was not found.

       GD_E_BAD_DIRFILE
	       The supplied dirfile was invalid.

       GD_E_BAD_FIELD_TYPE
	       An attempt was made to rename the immutable INDEX field.

       GD_E_BAD_REPR
	       The representation suffix specified in field_code was not recognised.

       GD_E_DUPLICATE
	       The new name specified is already in use by another field.

       GD_E_PROTECTED
	       The metadata of the format specification fragment containing the field was protected from change, or the binary data of	the  frag-
	       ments was protected from change and binary file translation was requested.

       GD_E_RAW_IO
	       An I/O error occurred while attempting to rename the binary file.

       GD_E_UNKNOWN_ENCODING
	       The encoding scheme of the specified field could not be determined or was not understood by GetData.

       GD_E_UNSUPPORTED
	       The encoding scheme of the field does not support binary file renaming.

       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).

SEE ALSO

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

Version 0.7.0							   20 July 2010 						      gd_rename(3)