1get_frameoffset(3)                  GETDATA                 get_frameoffset(3)
2
3
4

NAME

6       get_frameoffset — report the starting frame of fields in a dirfile
7

SYNOPSIS

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

DESCRIPTION

14       The  get_frameoffset() function queries a dirfile(5) database specified
15       by dirfile and returns the frame offset (see dirfile-format(5)) for the
16       fragment indexed by fragment_index.  The frame offset of a fragment in‐
17       dicate the frame number of the first sample of data  stored  in  binary
18       files  associated  with  RAW  fields defined in the specified fragment.
19       The frame offset of a fragment containing no RAW fields is ignored.
20
21       The dirfile argument must point to a valid  DIRFILE  object  previously
22       created by a call to dirfile_open(3).
23
24

RETURN VALUE

26       Upon  successful completion, get_frameoffset() returns the frame offset
27       of the specified fragment.  On  error,  it  returns  -1  and  sets  the
28       dirfile error to a non-zero error value.  Possible error values are:
29
30       GD_E_BAD_DIRFILE
31               The supplied dirfile was invalid.
32
33       GD_E_BAD_INDEX
34               The supplied index was out of range.
35
36       The dirfile error may be retrieved by calling get_error(3).  A descrip‐
37       tive error string for the last error encountered can be obtained from a
38       call to get_error_string(3).
39

SEE ALSO

41       dirfile_alter_frameoffset(3),   dirfile_open(3),   getdata(3),  get_er‐
42       ror(3), get_error_string(3), dirfile(5), dirfile-format(5)
43
44
45
46Version 0.5.0                   8 December 2008             get_frameoffset(3)
Impressum