gd_delete(3) [debian man page]
gd_delete(3) GETDATA gd_delete(3) NAME
gd_delete -- remove a field from a dirfile SYNOPSIS
#include <getdata.h> int gd_delete(DIRFILE *dirfile, const char *field_code, int flags); DESCRIPTION
The gd_delete() function attempts to delete the field specified by field_code in the dirfile specified by dirfile. The field_code should not contain a representation suffix. The flags argument influences how the deletion attempt occurs. It may be zero, for the default behaviour, or else one or more of the fol- lowing flags, bitwise or'd together: GD_DEL_DATA If the field to be deleted is a RAW field, also delete the binary data file associated with it. If field_code specified a RAW field and this flag is not specified, the field will still be deleted but the binary file will be left untouched. GD_DEL_DEREF If the field to be deleted is a CONST or CARRAY field which is used as a parameter in the specification of other fields, resolve these other fields dependence on the deleted field by replacing instances of field_code in their field specifications with the val- ue of the scalar field. GD_DEL_FORCE Delete the indicated field, even if it is used in the specification of other fields, either as a input for a derived vector field or as a scalar parameter in a field specification. GD_DEL_META If the field to be deleted has metafields attached to it, attempt to delete those, too. If the field has metafields and this flag is not specified, the call will fail with the GD_E_DELETE error. RETURN VALUE
On successful deletion, zero is returned. 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 field_code was not found in the database. GD_E_BAD_DIRFILE The supplied dirfile was invalid. GD_E_DELETE The attempt to delete the field failed. Either the specified field is used in the specification of other fields and GD_DEL_FORCE or GD_DEL_DEREF was not specified, or it has metafields and GD_DEL_META was not 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 GetData developers. GD_E_PROTECTED The metadata of the fragment containing the field was protected from change. Or, the deletion of the binary data file associated with a RAW field was attempted and the data of the fragment was protected. GD_E_RAW_IO An error occurred while trying to close or delete the binary file associated with a RAW field. GD_E_UNKNOWN_ENCODING The GD_DEL_DATA flag was given but the encoding scheme of the indicated format specification fragment is not known to the library. As a result, the library was unable to delete the binary file associated with a RAW field. GD_E_UNSUPPORTED The GD_DEL_DATA flag was given but the encoding scheme of the indicated format specification fragment does not support deleting the binary file associated with a RAW field. 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_open(3), gd_close(3), gd_error(3), gd_error_string(3), gd_metaflush(3) Version 0.7.0 3 November 2010 gd_delete(3)
Check Out this Related Man Page
gd_eof(3) GETDATA gd_eof(3) NAME
gd_eof -- report the number of samples in a dirfile field SYNOPSIS
#include <getdata.h> off_t gd_eof(DIRFILE *dirfile, const char *field_code); DESCRIPTION
The gd_eof() function queries a dirfile(5) database specified by dirfile and returns the sample number of the end-of-field marker for the vector field given by field_code. This is effectively the total number of samples available for the field, including any frame offset. The caller should not assume that this is equivalent (when accounting for the samples-per-frame of the indicated field) to the number of frames in the database returned by gd_nframes(3), nor even that the end-of-field marker falls on a frame boundary. For a RAW field, the end-of-field marker occurs immediately after the last datum in the data file associated with the field. For other field types, the end-of-field marker is equivalent to the end-of-field marker closest to the start of the dirfile of any of the field in- puts. The special field INDEX has no end-of-field marker. The end-of-field marker for a field containing no data is in the same location as, or before, its beginning-of-field marker (see gd_bof(3)). For a RAW field, the difference between the locations of the beginning- and end-of-field markers indicates the number of sam- ples 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_eof() 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_FIELD_TYPE The location of the non-existent end-of-field marker for the special field INDEX was requested, possibly as a result of the field specified by field_code using INDEX as one of its inputs. 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_RAW_IO An attempt to stat(2) the file associated with the field, or one of its input fields, failed. 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. GD_E_UNKNOWN_ENCODING The size of the decoded data file associated with the specified field or one of its inputs could not be determined, because its en- coding scheme was not understood. GD_E_UNSUPPORTED The size of the decoded data file associated with the specified field or one of its inputs could not be determined, because its en- coding scheme was not supported. 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_bof(3), gd_error(3), gd_error_string(3), gd_nframes(3) Version 0.7.0 15 October 2010 gd_eof(3)