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_get_string(3) | GETDATA | gd_get_string(3) |
NAME¶
gd_get_string — retrieve a string from a dirfile databaseSYNOPSIS¶
#include <getdata.h>size_t
gd_get_string(DIRFILE *dirfile, const char
*field_code, size_t len, char
*data_out);
DESCRIPTION¶
The gd_get_string() function queries a dirfile(5) database specified by dirfile for the string scalar field_code, which should not contain a representation suffix. The first len characters of the string scalar are stored in the user-supplied buffer data_out.RETURN VALUE¶
On success, gd_get_string() returns the actual length of the specified string scalar, including the trailing NULL character. A return value greater than len indicates that the output string is not null terminated.- GD_E_BAD_CODE
- The field specified by field_code was not found in the database.
- GD_E_BAD_DIRFILE
- An invalid dirfile was supplied.
- GD_E_BAD_FIELD_TYPE
- The supplied field_code referred to a field of type other than STRING. The caller should use gd_getdata(3), or gd_get_constant(3) instead.
- GD_E_BAD_TYPE
- An invalid return_type was specified.
- GD_E_INTERNAL_ERROR
- An internal error occurred in the library while trying to perform the task. This indicates a bug in the library. Please report the incident to the maintainer.
SEE ALSO¶
dirfile(5), gd_open(3), gd_error(3), gd_error_string(3), gd_put_string(3)25 May 2010 | Version 0.7.0 |