get_constant (3) - Linux Man Pages
get_constant: retrieve a scalar constant from a dirfile database
NAMEget_constant --- retrieve a scalar constant from a dirfile database
- int get_constant(DIRFILE *dirfile, const char *field_code, gd_type_t return_type, void *data_out);
The dirfile argument must point to a valid DIRFILE object previously created by a call to dirfile_open(3). The argument data_out must point to a valid memory location of sufficient size to hold a value of the return type specified.
The return_type argument should be one of the following symbols, which indicates the desired return type of the data:
- unsigned 8-bit integer
- signed (two's complement) 8-bit integer
- unsigned 16-bit integer
- signed (two's complement) 16-bit integer
- unsigned 32-bit integer
- signed (two's complement) 32-bit integer
- unsigned 64-bit integer
- signed (two's complement) 64-bit integer
- IEEE-754 standard 32-bit single precision floating point number
- IEEE-754 standard 64-bit double precision floating point number
- C99-conformant 64-bit single precision complex number
- C99-conformant 128-bit double precision complex number
- the null type: the database is queried as usual, but no data is returned. In this case, data_out is ignored and may be NULL.
The return type of the constant need not be the same as the type of the data stored in the database. Type conversion will be performed as necessary to return the requested type. If the field_code does not indicate a representation, but conversion from a complex value to a purely real one is required, only the real portion of the requested vector will be returned.
RETURN VALUEOn success, get_constant() returns zero. On error, it returns -1 and sets the dirfile error to a non-zero value. Possible error values are:
- The field specified by field_code was not found in the database.
- An invalid dirfile was supplied.
- The supplied field_code referred to a field of a type other than CONST. The caller should use getdata(3), or get_string(3) instead.
- The representation suffix specified in fieldcode, or in one of the field codes it uses for input, was invalid.
- An invalid return_type was specified.
- 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. The dirfile error may be retrieved by calling get_error(3). A descriptive error string for the last error encountered may be obtained from a call to get_error_string(3).