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_mfield_list_by_type(3) | GETDATA | gd_mfield_list_by_type(3) |
NAME¶
gd_mfield_list_by_type — retrieve a list of fields in a dirfileSYNOPSIS¶
#include <getdata.h>const char
**gd_mfield_list_by_type(DIRFILE *dirfile, const char
*parent, gd_entype_t type);
DESCRIPTION¶
The gd_mfield_list_by_type() function queries a dirfile(5) database specified by dirfile and returns a read-only list of names of the all metafields of the indicated type for the supplied parent field.- GD_BIT_ENTRY, GD_CARRAY_ENTRY, GD_CONST_ENTRY, GD_DIVIDE_ENTRY, GD_INDEX_ENTRY, GD_LINCOM_ENTRY, GD_LINTERP_ENTRY, GD_MULTIPLY_ENTRY, GD_PHASE_ENTRY, GD_POLYNOM_ENTRY, GD_RECIP_ENTRY, GD_SBIT_ENTRY, GD_STRING_ENTRY.
RETURN VALUE¶
Upon successful completion, gd_mfield_list_by_type() returns a pointer to an array of strings containing the names of all the metafields of the specific type for the given parent. 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_CODE
- The supplied parent field code was not found, or referred to a metafield itself.
- GD_E_BAD_DIRFILE
- The supplied dirfile was invalid.
SEE ALSO¶
dirfile(5), gd_error(3), gd_error_string(3), gd_field_list_by_type(3), gd_mconstants(3), gd_mfield_list(3), gd_mstrings(3), gd_nmfields_by_type(3), gd_open(3)3 November 2010 | Version 0.7.0 |