libexplain/buffer/errno/getc.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/buffer/ebadf.h>
#include <libexplain/buffer/errno/getc.h>
#include <libexplain/buffer/errno/read.h>
#include <libexplain/buffer/gettext.h>
#include <libexplain/buffer/is_the_null_pointer.h>
#include <libexplain/buffer/software_error.h>
#include <libexplain/buffer/stream.h>
#include <libexplain/explanation.h>
#include <libexplain/libio.h>
#include <libexplain/stream_to_fildes.h>

Go to the source code of this file.

Functions
static void	explain_buffer_errno_getc_system_call (explain_string_buffer_t *sb, int errnum, FILE *fp)
static void	explain_buffer_errno_getc_explanation (explain_string_buffer_t *sb, int errnum, FILE *fp)
void	explain_buffer_errno_getc (explain_string_buffer_t *sb, int errnum, FILE *fp)

---

Function Documentation

void explain_buffer_errno_getc	(	explain_string_buffer_t *	sb,
		int	errnum,
		FILE *	fp
	)

The explain_buffer_errno_getc function is used to obtain an explanation of an error returned by the getc(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:

sb	The string buffer to print the message into. If a safe buffer is specified, this function is thread safe.
errnum	The 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.
fp	The original fp, exactly as passed to the getc(3) system call.

Definition at line 82 of file getc.c.

static void explain_buffer_errno_getc_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		FILE *	fp
	)		[static]

Definition at line 45 of file getc.c.

static void explain_buffer_errno_getc_system_call	(	explain_string_buffer_t *	sb,
		int	errnum,
		FILE *	fp
	)		[static]

Definition at line 34 of file getc.c.