table of contents
other versions
- wheezy 0.7.3-6
- jessie 0.7.3-6+b2
- testing 0.9.4-1
- unstable 0.9.4-1
- experimental 0.10.0-1
gd_mcarrays(3) | GETDATA | gd_mcarrays(3) |
NAME¶
gd_constants — retrieve a list of CARRAY values from a dirfileSYNOPSIS¶
#include <getdata.h>const
gd_carray_t *gd_mcarrays(DIRFILE *dirfile, const char
*parent, gd_type_t return_type);
DESCRIPTION¶
The gd_mcarrays() function queries a dirfile(5) database specified by dirfile and returns a read-only list of values of the all CARRAY metafields for the supplied parent field, after type conversion to the data type specified by return_type. For a list of valid symbols to use for return_type, see the gd_get_carray(3) man page.RETURN VALUE¶
Upon successful completion, gd_mcarrays() returns a pointer to an array of gd_carray_t objects containing the values of all the CARRAYs defined in the dirfile database. The gd_carray_t is defined as:typedef struct { size_t n; /* array_len */ void *d; /* CARRAY data */ } gd_carray_t;
where n specifies the length of the CARRAY data, and d is an array of the data values themselves. The caller should cast the void pointer to a type appropriate for the return_type specified. The list is terminated by an end-of-list marker consisting of a gd_carray_t item with n set to zero.
- GD_E_ALLOC
- The library was unable to allocate memory.
- 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.
- GD_E_BAD_TYPE
- The return_type specified was invalid.
SEE ALSO¶
dirfile(5), gd_carrays(3), gd_error(3), gd_error_string(3), gd_get_carray(3), gd_mfield_list_by_type(3), gd_nmfields_by_type(3), gd_open(3)3 November 2010 | Version 0.7.0 |