libexplain/buffer/errno/fgetc.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_fgetc (explain_string_buffer_t *sb, int errnum, FILE *fp)
void	explain_buffer_errno_fgetc_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, FILE *fp)

---

Function Documentation

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

The explain_buffer_errno_fgetc function is used to obtain an explanation of an error returned by the fgetc(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 fgetc(3) system call.

Definition at line 86 of file fgetc.c.

void explain_buffer_errno_fgetc_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		FILE *	fp
	)

The explain_buffer_errno_fgetc_explanation function is used to obtain an explanation of an error returned by the fgetc(3) system call.

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.
syscall_name	The name of the offended system call.
fp	The original fp, exactly as passed to the fgetc(3) system call.

Definition at line 44 of file fgetc.c.