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

---

Function Documentation

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

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

Note:

Given a suitably thread safe buffer, this function is thread safe.

Definition at line 82 of file fflush.c.

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

The explain_buffer_errno_fflush_explanation is used by the explain_buffer_errno_fflush function (and others) to decode the errno value.

Parameters:

sb	The string buffer into which the message is to be written.
errnum	The error value to be decoded.
syscall_name	The name of the offending system call.
fp	The original fp, exactly as passed to the fflush(3) system call.

Definition at line 42 of file fflush.c.