libexplain  1.4.D001
Functions
libexplain/buffer/errno/setbuffer.h File Reference
#include <libexplain/ac/stdio.h>
#include <libexplain/string_buffer.h>

Go to the source code of this file.

Functions

void explain_buffer_errno_setbuffer (explain_string_buffer_t *sb, int errnum, FILE *fp, char *data, size_t size)
void explain_buffer_errno_setbuffer_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, FILE *fp, char *data, size_t size)

Function Documentation

void explain_buffer_errno_setbuffer ( explain_string_buffer_t sb,
int  errnum,
FILE *  fp,
char *  data,
size_t  size 
)

The explain_buffer_errno_setbuffer function is used to obtain an explanation of an error returned by the setbuffer(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.
fpThe original fp, exactly as passed to the setbuffer(3) system call.
dataThe original data, exactly as passed to the setbuffer(3) system call.
sizeThe original size, exactly as passed to the setbuffer(3) system call.

Definition at line 65 of file setbuffer.c.

void explain_buffer_errno_setbuffer_explanation ( explain_string_buffer_t sb,
int  errnum,
const char *  syscall_name,
FILE *  fp,
char *  data,
size_t  size 
)

The explain_buffer_errno_setbuffer_explanation function is used to obtain the explanation (the part after "because") of an error returned by the setbuffer(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.
fpThe original fp, exactly as passed to the setbuffer(3) system call.
dataThe original data, exactly as passed to the setbuffer(3) system call.
sizeThe original size, exactly as passed to the setbuffer(3) system call.

Definition at line 45 of file setbuffer.c.