get_error_string — report a getdata library error
Synopsis
#include <getdata.h>
- char *get_error_string(const DIRFILE *dirfile, char *buffer, size_t buflen);
Description
The get_error_string() function returns a string describing the last dirfile error encountered while operating on dirfile. The string is written to the user-supplied buffer buffer. At most buflen characters will be written. This always includes a terminating null byte, even if the error string was truncated. The numeric dirfile error itself may be obtained by calling get_error(3).
The dirfile argument should point to a DIRFILE object previously created by a call to dirfile_open(3).
Return Value
The get_error_string() function returns buffer, or NULL if buflen is less than one. The error state of dirfile is unchanged.
See Also
dirfile_open(3), get_error(3).
