table of contents
gd_array_len(3) | GETDATA | gd_array_len(3) |
NAME¶
gd_array_len — returns the length of a CARRAY or SARRAY field in a dirfileSYNOPSIS¶
#include <getdata.h>size_t gd_array_len(DIRFILE *dirfile, const char *field_code);
DESCRIPTION¶
The gd_array_len() function queries a dirfile(5) database specified by dirfile and returns the number of length of the CARRAY, CONST, STRING, or SARRAY field called field_code. If field_code contains a valid representation suffix, it will be ignored.The dirfile argument must point to a valid DIRFILE object previously created by a call to gd_open(3).
RETURN VALUE¶
Upon successful completion, gd_array_len() returns the array length of the field specified. (The length of a CONST or a STRING field is always 1.) On error, it returns zero 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 field specified by field_code was not found in the database.
- GD_E_BAD_DIRFILE
- The supplied dirfile was invalid.
- GD_E_BAD_FIELD_TYPE
- The field specified by field_code was not of one of the field types listed above.
The dirfile error may be retrieved by calling gd_error(3). A descriptive error string for the last error encountered can be obtained from a call to gd_error_string(3).
NOTES¶
This function used to be called gd_carray_len(). This name can still be used, but it has been marked deprecated.SEE ALSO¶
dirfile(5), gd_open(3), gd_error(3), gd_error_string(3)27 May 2014 | Version 0.9.0 |