get_nmfields (3) - Linux Man Pages

get_nmfields: report the number of metafields in a dirfile

NAME

get_nmfields --- report the number of metafields in a dirfile

SYNOPSIS

#include <getdata.h>
unsigned int get_nmfields(DIRFILE *dirfile, const char *parent);

DESCRIPTION

The get_nmfields() function queries a dirfile(5) database specified by dirfile and returns the number of metafields defined in the database for the parent field specified by parent.

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_nmfields() returns the number of defined metafields for the given parent. On error, it returns zero and sets the dirfile error to a non-zero error value. Possible error values are:
GD_E_BAD_CODE
The supplied parent field code was not found, or referred to a metafield itself.
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).