SIMPLE SOLUTIONS

GD_ERROR_STRING(3) - man page online | library functions

Report a GetData library error.

Chapter
16 October 2014
gd_error_string(3)                           GETDATA                           gd_error_string(3)

NAME

gd_error_string — report a GetData library error

SYNOPSIS

#include <getdata.h> char *gd_error_string(const DIRFILE *dirfile, char *buffer, size_t buflen);

DESCRIPTION

The gd_error_string() function returns a string describing the last dirfile error encoun‐ tered while operating on dirfile. If buffer is not NULL, the string is written to this memory location. At most buflen characters will be written. This always includes a terminating null byte, even if the er‐ ror string was truncated. The numeric dirfile error itself may be obtained by calling gd_error(3). If buffer is NULL, gd_error_string() will allocate a string of sufficient length using malloc(3), and buflen is ignored. In this case, the caller should deallocate the returned string using free(3) when it is no longer needed.

RETURN VALUE

If buffer is non-NULL, the gd_error_string() function returns buffer, or NULL if buflen is less than one. If buffer is NULL, this function returns a newly malloc'd string of suffi‐ cient length which should be deallocated by the caller, or NULL, if memory allocation failed. In all cases, the error state of dirfile is unchanged.

SEE ALSO

gd_error(3), gd_error_count(3)
Version 0.9.0 16 October 2014 gd_error_string(3)
This manual Reference Other manuals
gd_error_string(3) referred by gd_add(3) | gd_add_alias(3) | gd_add_bit(3) | gd_add_spec(3) | gd_alias_target(3) | gd_aliases(3) | gd_alter_affixes(3) | gd_alter_bit(3) | gd_alter_encoding(3) | gd_alter_endianness(3) | gd_alter_entry(3) | gd_alter_frameoffset(3) | gd_alter_protection(3) | gd_alter_spec(3) | gd_array_len(3) | gd_bof(3) | gd_carrays(3) | gd_cbopen(3) | gd_close(3) | gd_constants(3)
refer to gd_error(3) | gd_error_count(3) | malloc(3)