1get_nvectors(3) GETDATA get_nvectors(3)
2
3
4
6 get_nvectors — report the number of vector fields in a dirfile
7
9 #include <getdata.h>
10
11 unsigned int get_nvectors(DIRFILE *dirfile);
12
14 The get_nvectors() function queries a dirfile(5) database specified by
15 dirfile and returns the number of vector fields defined in the database
16 (i.e. fields of types BIT, LINCOM, LINTERP, MULTIPLY, PHASE, POLY‐
17 NOM, RAW, SBIT). Notably, this count does not include /META fields.
18
19 The dirfile argument must point to a valid DIRFILE object previously
20 created by a call to dirfile_open(3).
21
22
24 Upon successful completion, get_nvectors() returns the number of vector
25 fields in the dirfile. On error, it returns zero and sets the dirfile
26 error to a non-zero error value. Possible error values are:
27
28 GD_E_BAD_DIRFILE
29 The supplied dirfile was invalid.
30
31 The dirfile error may be retrieved by calling get_error(3). A descrip‐
32 tive error string for the last error encountered can be obtained from a
33 call to get_error_string(3).
34
36 dirfile(5), dirfile_open(3), getdata(3), get_error(3), get_er‐
37 ror_string(3), get_nfields(3), get_nmvectors(3), get_vector_list(3)
38
39
40
41Version 0.6.0 16 October 2009 get_nvectors(3)