libexplain/buffer/errno/vsprintf.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_vsprintf (explain_string_buffer_t *sb, int errnum, char *data, const char *format, va_list ap) LIBEXPLAIN_FORMAT_PRINTF(4
void void	explain_buffer_errno_vsprintf_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, char *data, const char *format, va_list ap) LIBEXPLAIN_FORMAT_PRINTF(5

---

Function Documentation

void explain_buffer_errno_vsprintf	(	explain_string_buffer_t *	sb,
		int	errnum,
		char *	data,
		const char *	format,
		va_list	ap
	)

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

void void explain_buffer_errno_vsprintf_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		char *	data,
		const char *	format,
		va_list	ap
	)

The explain_buffer_errno_vsprintf_explanation function is used to obtain the explanation (the part after "because") of an error returned by the vsprintf(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.
data	The original data, exactly as passed to the vsprintf(3) system call.
format	The original format, exactly as passed to the vsprintf(3) system call.
ap	The original ap, exactly as passed to the vsprintf(3) system call.