1get_nmvectors(3)                    GETDATA                   get_nmvectors(3)
2
3
4

NAME

6       get_nmvectors — report the number of vector fields in a dirfile
7

SYNOPSIS

9       #include <getdata.h>
10
11       unsigned int get_nmvectors(DIRFILE *dirfile);
12

DESCRIPTION

14       The get_nmvectors() function queries a dirfile(5) database specified by
15       dirfile and returns the number of  vector  metafields  defined  in  the
16       database  (i.e.  fields of types BIT, LINCOM, LINTERP, MULTIPLY, PHASE,
17       and RAW)for the supplied parent field.
18
19       The dirfile argument must point to a valid  DIRFILE  object  previously
20       created by a call to dirfile_open(3).
21
22

RETURN VALUE

24       Upon  successful completion, get_nmvectors() returns the number of vec‐
25       tor metafields in the dirfile for the given parent.  On error,  it  re‐
26       turns  zero and sets the dirfile error to a non-zero error value.  Pos‐
27       sible error values are:
28
29       GD_E_BAD_CODE
30               The supplied parent field code was not found, or referred to  a
31               metafield itself.
32
33       GD_E_BAD_DIRFILE
34               The supplied dirfile was invalid.
35
36       The dirfile error may be retrieved by calling get_error(3).  A descrip‐
37       tive error string for the last error encountered can be obtained from a
38       call to get_error_string(3).
39

SEE ALSO

41       dirfile(5),    dirfile_open(3),    get_error(3),   get_error_string(3),
42       get_mvector_list(3), get_nmfields(3), get_nvectors(3)
43
44
45
46Version 0.5.0                   8 December 2008               get_nmvectors(3)
Impressum