gd_nfields (3)

Contents

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
SEE ALSO

NAME

gd_nfields --- report the number of fields in a dirfile

SYNOPSIS

#include <getdata.h>
unsigned int gd_nfields(DIRFILE *dirfile);

DESCRIPTION

The gd_nfields() function queries a dirfile(5) database specified by dirfile and returns the number of fields defined in the database. Notably, this count does not include /META fields.

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_nfields() returns the number of defined fields in the dirfile. On error, it returns zero and sets the dirfile error to a non-zero error value. Possible error values are:
GD_E_BAD_DIRFILE
The supplied dirfile was invalid.

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).

SEE ALSO

dirfile(5), gd_open(3), gd_error(3), gd_error_string(3), gd_field_list(3), gd_nfields_by_type(3), gd_nmfields(3), gd_nvectors(3)