libexplain/buffer/errno/setvbuf.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_setvbuf (explain_string_buffer_t *sb, int errnum, FILE *fp, char *data, int mode, size_t size)
void	explain_buffer_errno_setvbuf_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, FILE *fp, char *data, int mode, size_t size)

---

Function Documentation

void explain_buffer_errno_setvbuf	(	explain_string_buffer_t *	sb,
		int	errnum,
		FILE *	fp,
		char *	data,
		int	mode,
		size_t	size
	)

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

Definition at line 94 of file setvbuf.c.

void explain_buffer_errno_setvbuf_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		FILE *	fp,
		char *	data,
		int	mode,
		size_t	size
	)

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

Definition at line 51 of file setvbuf.c.