gd_spf
returns the samples per frame for a field in a dirfile
- Provided by: libgetdata-dev (Version: 0.7.3-6ubuntu1)
- Source: libgetdata
- Report a bug
returns the samples per frame for a field in a dirfile
#include <getdata.h>
gd_spf_t gd_spf(DIRFILE *dirfile, const char *field_code);
The gd_spf() function queries a dirfile(5) database specified by dirfile and returns the number of samples per frame for the field field_code. If field_code contains a valid representation suffix, it will be ignored. The gd_spf_t type is an unsigned 16-bit integer type.
The dirfile argument must point to a valid DIRFILE object previously created by a call to gd_open(3).
Upon successful completion, gd_spf() returns the number of samples per frame for the field specified. On error, it returns zero and sets the dirfile error to a non-zero error value. Possible error values are:
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).