table of contents
other versions
- wheezy 0.7.3-6
- jessie 0.7.3-6+b2
- testing 0.9.4-1
- unstable 0.9.4-1
- experimental 0.10.0-1
gd_eof(3) | GETDATA | gd_eof(3) |
NAME¶
gd_eof — report the number of samples in a dirfile fieldSYNOPSIS¶
#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.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 encoding 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 encoding scheme was not supported.
SEE ALSO¶
dirfile(5), dirfile-encoding(5), gd_open(3), gd_bof(3), gd_error(3), gd_error_string(3), gd_nframes(3)15 October 2010 | Version 0.7.0 |