table of contents
gd_nfragments(3) | GETDATA | gd_nfragments(3) |
NAME¶
gd_nfragments — retrieve the number of format specification fragments in a dirfile
SYNOPSIS¶
#include <getdata.h>
int gd_nfragments(const DIRFILE *dirfile);
DESCRIPTION¶
The gd_nfragments() function queries a dirfile(5) database specified by dirfile and returns the total number of parsed format specification fragments in the database.
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_nfragments() returns the total number of format specification fragments which are present in the dirfile.
On error, this function return zero and store a negative-valued error code in the DIRFILE object which may be retrieved by a subsequent call to gd_error(3). Possible error codes are:
- GD_E_BAD_DIRFILE
- The supplied dirfile was invalid.
A descriptive error string for the error may be obtained by calling gd_error_string(3).
HISTORY¶
The get_nfragments() function appeared in GetData-0.4.0.
In GetData-0.7.0, this function was renamed to gd_nfragments().
SEE ALSO¶
dirfile(5), gd_fragmentname(3), gd_include(3), gd_open(3), gd_parent_fragment(3)
25 December 2016 | Version 0.10.0 |