libexplain/buffer/errno/vfprintf.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_vfprintf (explain_string_buffer_t *sb, int errnum, FILE *fp, const char *format, va_list ap)
void	explain_buffer_errno_vfprintf_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, FILE *fp, const char *format, va_list ap)

---

Function Documentation

void explain_buffer_errno_vfprintf	(	explain_string_buffer_t *	sb,
		int	errnum,
		FILE *	fp,
		const char *	format,
		va_list	ap
	)

The explain_buffer_errno_vfprintf function is used to obtain an explanation of an error returned by the vfprintf(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 vfprintf(3) system call.
format	The original format, exactly as passed to the vfprintf(3) system call.
ap	The original ap, exactly as passed to the vfprintf(3) system call.

Definition at line 192 of file vfprintf.c.

void explain_buffer_errno_vfprintf_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		FILE *	fp,
		const char *	format,
		va_list	ap
	)

The explain_buffer_errno_vfprintf_explanation function is used to obtain the explanation (the part after "because") of an error returned by the vfprintf(3) system call (and similar).

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

Definition at line 54 of file vfprintf.c.