libexplain/buffer/errno/putw.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/buffer/errno/fputc.h>
#include <libexplain/buffer/errno/putw.h>
#include <libexplain/buffer/int.h>
#include <libexplain/buffer/stream.h>
#include <libexplain/explanation.h>

Go to the source code of this file.

Functions
static void	explain_buffer_errno_putw_system_call (explain_string_buffer_t *sb, int errnum, int value, FILE *fp)
void	explain_buffer_errno_putw_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, int value, FILE *fp)
void	explain_buffer_errno_putw (explain_string_buffer_t *sb, int errnum, int value, FILE *fp)

---

Function Documentation

void explain_buffer_errno_putw	(	explain_string_buffer_t *	sb,
		int	errnum,
		int	value,
		FILE *	fp
	)

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

Definition at line 51 of file putw.c.

void explain_buffer_errno_putw_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		int	value,
		FILE *	fp
	)

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

Definition at line 42 of file putw.c.

static void explain_buffer_errno_putw_system_call	(	explain_string_buffer_t *	sb,
		int	errnum,
		int	value,
		FILE *	fp
	)		[static]

Definition at line 29 of file putw.c.