libexplain  1.4.D001
Functions
libexplain/buffer/errno/getchar.c File Reference
#include <libexplain/ac/errno.h>
#include <libexplain/ac/stdio.h>
#include <libexplain/buffer/ebadf.h>
#include <libexplain/buffer/errno/getchar.h>
#include <libexplain/buffer/errno/read.h>
#include <libexplain/buffer/software_error.h>
#include <libexplain/buffer/stream_to_pathname.h>
#include <libexplain/explanation.h>
#include <libexplain/libio.h>

Go to the source code of this file.

Functions

static void explain_buffer_errno_getchar_system_call (explain_string_buffer_t *sb, int errnum)
static void explain_buffer_errno_getchar_explanation (explain_string_buffer_t *sb, int errnum)
void explain_buffer_errno_getchar (explain_string_buffer_t *sb, int errnum)

Function Documentation

void explain_buffer_errno_getchar ( explain_string_buffer_t sb,
int  errnum 
)

The explain_buffer_errno_getchar function is used to obtain an explanation of an error returned by the getchar(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 safe 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.

Definition at line 76 of file getchar.c.

static void explain_buffer_errno_getchar_explanation ( explain_string_buffer_t sb,
int  errnum 
) [static]

Definition at line 43 of file getchar.c.

static void explain_buffer_errno_getchar_system_call ( explain_string_buffer_t sb,
int  errnum 
) [static]

Definition at line 32 of file getchar.c.