get_nmvectors (3) - Linux Manuals

get_nmvectors: report the number of vector fields in a dirfile

Command to display get_nmvectors manual in Linux: $ man 3 get_nmvectors

NAME

get_nmvectors --- report the number of vector fields in a dirfile

SYNOPSIS

#include <getdata.h>

unsigned int get_nmvectors(DIRFILE *dirfile);

DESCRIPTION

The get_nmvectors() function queries a dirfile(5) database specified by dirfile and returns the number of vector metafields defined in the database (i.e. fields of types BIT, LINCOM, LINTERP, MULTIPLY, PHASE, and RAW)for the supplied parent field.

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_nmvectors() returns the number of vector metafields in the dirfile 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).