libexplain/buffer/errno/fputs.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/buffer/ebadf.h>
#include <libexplain/buffer/errno/fputs.h>
#include <libexplain/buffer/errno/write.h>
#include <libexplain/buffer/pathname.h>
#include <libexplain/buffer/software_error.h>
#include <libexplain/buffer/stream.h>
#include <libexplain/explanation.h>
#include <libexplain/libio.h>
#include <libexplain/stream_to_fildes.h>

Go to the source code of this file.

Functions
static void	explain_buffer_errno_fputs_system_call (explain_string_buffer_t *sb, int errnum, const char *s, FILE *fp)
void	explain_buffer_errno_fputs_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, const char *s, FILE *fp)
void	explain_buffer_errno_fputs (explain_string_buffer_t *sb, int errnum, const char *s, FILE *fp)

---

Function Documentation

void explain_buffer_errno_fputs	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	s,
		FILE *	fp
	)

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

Definition at line 84 of file fputs.c.

void explain_buffer_errno_fputs_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		const char *	s,
		FILE *	fp
	)

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

Definition at line 46 of file fputs.c.

static void explain_buffer_errno_fputs_system_call	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	s,
		FILE *	fp
	)		[static]

Definition at line 33 of file fputs.c.