get_nfragments

Langue: en

Autres versions - même langue

Version: 14 December 2008 (fedora - 06/07/09)

Section: 3 (Bibliothèques de fonctions)

NAME

get_nfragments --- retrieve the number of format file fragments in a dirfile

SYNOPSIS

#include <getdata.h>
int get_nfragments(const DIRFILE *dirfile);

DESCRIPTION

The get_nfragments() function queries a dirfile(5) database specified by dirfile and returns the total number of parsed format file fragments in the database.

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_nfragments() returns the total number of format file fragments which are present in the dirfile. On error, get_nfragments() returns zero and sets the dirfile error to a non-zero value. Possible error values are:
GD_E_BAD_DIRFILE
The supplied dirfile was invalid.

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(5), dirfile_include(3), dirfile_open(3), get_fragmentname(3), get_parent_fragment(3)