libexplain/buffer/errno/write.h File Reference

#include <libexplain/ac/stddef.h>
#include <libexplain/string_buffer.h>

Go to the source code of this file.

Functions
void	explain_buffer_errno_write (explain_string_buffer_t *sb, int errnum, int fildes, const void *data, size_t data_size)
void	explain_buffer_errno_write_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, int fildes, const void *data, size_t data_size)

---

Function Documentation

void explain_buffer_errno_write	(	explain_string_buffer_t *	sb,
		int	errnum,
		int	fildes,
		const void *	data,
		size_t	data_size
	)

The explain_buffer_errno_write function may be used to obtain a human readable explanation of what went wrong in a write(2) 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 into which the message is to be written.
errnum	The error value to be decoded, usually obtain 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.
fildes	The original fildes, exactly as passed to the write(2) system call.
data	The original data, exactly as passed to the write(2) system call.
data_size	The original data_size, exactly as passed to the write(2) system call.

Note:

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

Definition at line 357 of file write.c.

void explain_buffer_errno_write_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		int	fildes,
		const void *	data,
		size_t	data_size
	)

The explain_buffer_errno_write_explanation function is called by the explain_buffer_errno_write function (and others) to write the "because" part of the message.

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.
fildes	The original fildes, exactly as passed to the write(2) system call.
data	The original data, exactly as passed to the write(2) system call.
data_size	The original data_size, exactly as passed to the write(2) system call.

Definition at line 75 of file write.c.