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_constants(3) | GETDATA | gd_constants(3) |
NAME¶
gd_constants — retrieve a list of constant values from a dirfileSYNOPSIS¶
#include <getdata.h>const void
*gd_constants(DIRFILE *dirfile, gd_type_t
return_type);
DESCRIPTION¶
The gd_constants() function queries a dirfile(5) database specified by dirfile and returns a read-only list of values of the all CONST type fields defined in the database after type conversion to the data type specified by return_type. Notably, this list does not include /META subfields. For a list of valid symbols to use for return_type, see the gd_get_constant(3) man page.RETURN VALUE¶
Upon successful completion, gd_constants() returns a pointer to an array of values containing the values of all the constants defined in the dirfile database. If no constants are defined in the database, NULL is returned. On error it returns NULL and sets the dirfile error to a non-zero error value. Possible error values are:- GD_E_ALLOC
- The library was unable to allocate memory.
- GD_E_BAD_DIRFILE
- The supplied dirfile was invalid.
- GD_E_BAD_TYPE
- The return_type specified was invalid.
SEE ALSO¶
dirfile(5), gd_open(3), gd_error(3), gd_error_string(3), gd_field_list_by_type(3), gd_get_constant(3), gd_nfields_by_type(3)15 October 2010 | Version 0.7.0 |