·

get_frameoffset (3) Linux Manual Page

ByLinux Manual Posted on

get_frameoffset — report the starting frame of fields in a dirfile

Synopsis

#include <getdata.h>
off_t get_frameoffset(DIRFILE *dirfile, int fragment_index);

Description

The get_frameoffset() function queries a dirfile(5) database specified by dirfile and returns the frame offset (see dirfile-format(5)) for the fragment indexed by fragment_index. The frame offset of a fragment indicate the frame number of the first sample of data stored in binary files associated with RAW fields defined in the specified fragment. The frame offset of a fragment containing no RAW fields is ignored.

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

Return Value

Upon successful completion, get_frameoffset() returns the frame offset of the specified fragment. On error, it returns -1 and sets the dirfile error to a non-zero error value. Possible error values are:
GD_E_BAD_DIRFILE
The supplied dirfile was invalid.
GD_E_BAD_INDEX
The supplied index was out of range. The dirfile error may be retrieved by calling get_error(3). A descriptive error string for the last error encountered can be obtained from a call to get_error_string(3).

See Also

dirfile_alter_frameoffset(3), dirfile_open(3), getdata(3), get_error(3), get_error_string(3), dirfile(5), dirfile-format(5)

Leave a Reply

Your email address will not be published. Required fields are marked *