gd_error(3)

NAME
gd_error, gd_error_string — report a GetData library error

SYNOPSIS
#include <getdata.h>

int gd_error(const DIRFILE *dirfile);

char *gd_error_string(const DIRFILE *dirfile, char *buffer, size_t buflen);

DESCRIPTION
The function determines the success or failure of the most recent GetData library function call that operated on If the last call succeeded, will return GD_E_OK (which equals zero). If the last call failed, returns a negative-valued error code indicating the cause of the failure. Possible codes vary from function to function. See corresponding manual page of the function that failed for a list of possible codes.

The function behaves similarly, but composes a string describing the error. If is not NULL, the string is written to this memory location. At most characters will be written including the terminating NUL byte. If is not large enough to hold the entire string, the string will be truncated, but the truncated string will still be NUL-terminated.

If is NULL, will allocate a string of sufficient length on the heap. In this case, is ignored. By default, is used to allocate this buffer, but an alternate memory manager may be specified by calling before calling this function. The caller is responsible for deallocating this string when it is no longer needed.

The functions and are ignored by these functions, since they always succeed. Previous gd_error() and gd_error_string() calls are also ignored.

RETURN VALUE
The function always returns the integer error code of the last library call on the supplied DIRFILE object.

If is non-NULL, returns unless is less than one, in which case it returns NULL. If is NULL, this function returns a newly allocated string of sufficient length which should be deallocated by the caller, or NULL, if memory allocation failed.

HISTORY
The function appeared in GetData-0.3.0.

The function appeared in GetData-0.4.0. Before this, the error code was directly accessible via the member in the DIRFILE structure.

In GetData-0.7.0, these functions were renamed to and This is also the first release in which would allocate a buffer for the error string if passed NULL.

SEE ALSO