libexplain  1.4.D001
Functions
libexplain/buffer/errno/iconv.c File Reference
#include <libexplain/ac/errno.h>
#include <libexplain/buffer/errno/generic.h>
#include <libexplain/buffer/errno/iconv.h>
#include <libexplain/buffer/is_the_null_pointer.h>
#include <libexplain/buffer/pointer.h>
#include <libexplain/buffer/size_t.h>
#include <libexplain/explanation.h>

Go to the source code of this file.

Functions

static void explain_buffer_errno_iconv_system_call (explain_string_buffer_t *sb, int errnum, iconv_t cd, char **inbuf, size_t *inbytesleft, char **outbuf, size_t *outbytesleft)
void explain_buffer_errno_iconv_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, iconv_t cd, char **inbuf, size_t *inbytesleft, char **outbuf, size_t *outbytesleft)
void explain_buffer_errno_iconv (explain_string_buffer_t *sb, int errnum, iconv_t cd, char **inbuf, size_t *inbytesleft, char **outbuf, size_t *outbytesleft)

Function Documentation

void explain_buffer_errno_iconv ( explain_string_buffer_t sb,
int  errnum,
iconv_t  cd,
char **  inbuf,
size_t *  inbytesleft,
char **  outbuf,
size_t *  outbytesleft 
)

The explain_buffer_errno_iconv function is used to obtain an explanation of an error returned by the iconv(3) system call. The least the message will contain is the value of strerror(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

Parameters:
sbThe string buffer to print the message into. If a suitable buffer is specified, this function is thread safe.
errnumThe error value to be decoded, usually obtained from the errno global variable just before this function is called. This is necessary if you need to call any code between the system call to be explained and this function, because many libc functions will alter the value of errno.
cdThe original cd, exactly as passed to the iconv(3) system call.
inbufThe original inbuf, exactly as passed to the iconv(3) system call.
inbytesleftThe original inbytesleft, exactly as passed to the iconv(3) system call.
outbufThe original outbuf, exactly as passed to the iconv(3) system call.
outbytesleftThe original outbytesleft, exactly as passed to the iconv(3) system call.

Definition at line 111 of file iconv.c.

void explain_buffer_errno_iconv_explanation ( explain_string_buffer_t sb,
int  errnum,
const char *  syscall_name,
iconv_t  cd,
char **  inbuf,
size_t *  inbytesleft,
char **  outbuf,
size_t *  outbytesleft 
)

The explain_buffer_errno_iconv_explanation function is used to obtain the explanation (the part after "because") of an error returned by the iconv(3) system call (and similar).

Parameters:
sbThe string buffer to print the message into. If a suitable buffer is specified, this function is thread safe.
errnumThe error value to be decoded, usually obtained from the errno global variable just before this function is called. This is necessary if you need to call any code between the system call to be explained and this function, because many libc functions will alter the value of errno.
syscall_nameThe name of the offending system call.
cdThe original cd, exactly as passed to the iconv(3) system call.
inbufThe original inbuf, exactly as passed to the iconv(3) system call.
inbytesleftThe original inbytesleft, exactly as passed to the iconv(3) system call.
outbufThe original outbuf, exactly as passed to the iconv(3) system call.
outbytesleftThe original outbytesleft, exactly as passed to the iconv(3) system call.

Definition at line 50 of file iconv.c.

static void explain_buffer_errno_iconv_system_call ( explain_string_buffer_t sb,
int  errnum,
iconv_t  cd,
char **  inbuf,
size_t *  inbytesleft,
char **  outbuf,
size_t *  outbytesleft 
) [static]

Definition at line 30 of file iconv.c.