libexplain/buffer/errno/fwrite.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_fwrite (explain_string_buffer_t *sb, int errnum, const void *ptr, size_t size, size_t nmemb, FILE *fp)

---

Function Documentation

void explain_buffer_errno_fwrite	(	explain_string_buffer_t *	sb,
		int	errnum,
		const void *	ptr,
		size_t	size,
		size_t	nmemb,
		FILE *	fp
	)

The explain_buffer_errno_fwrite function is used to obtain an explanation of an error returned by the fwrite(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.
ptr	The original ptr, exactly as passed to the fwrite(3) system call.
size	The original size, exactly as passed to the fwrite(3) system call.
nmemb	The original nmemb, exactly as passed to the fwrite(3) system call.
fp	The original fp, exactly as passed to the fwrite(3) system call.

Definition at line 81 of file fwrite.c.