libexplain/buffer/errno/pipe2.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/fcntl.h>
#include <libexplain/buffer/efault.h>
#include <libexplain/buffer/einval.h>
#include <libexplain/buffer/emfile.h>
#include <libexplain/buffer/enfile.h>
#include <libexplain/buffer/errno/generic.h>
#include <libexplain/buffer/errno/pipe2.h>
#include <libexplain/buffer/is_the_null_pointer.h>
#include <libexplain/buffer/open_flags.h>
#include <libexplain/buffer/pointer.h>
#include <libexplain/explanation.h>

Go to the source code of this file.

Functions
static void	explain_buffer_errno_pipe2_system_call (explain_string_buffer_t *sb, int errnum, int *fildes, int flags)
void	explain_buffer_errno_pipe2_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, int *fildes, int flags)
void	explain_buffer_errno_pipe2 (explain_string_buffer_t *sb, int errnum, int *fildes, int flags)

---

Function Documentation

void explain_buffer_errno_pipe2	(	explain_string_buffer_t *	sb,
		int	errnum,
		int *	fildes,
		int	flags
	)

The explain_buffer_errno_pipe2 function is used to obtain an explanation of an error returned by the pipe2(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 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.
fildes	The original fildes, exactly as passed to the pipe2(2) system call.
flags	The original flags, exactly as passed to the pipe2(2) system call.

Definition at line 87 of file pipe2.c.

void explain_buffer_errno_pipe2_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		int *	fildes,
		int	flags
	)

The explain_buffer_errno_pipe2_explanation function is used to obtain the explanation (the part after "because") of an error returned by the pipe2(2) 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.
fildes	The original fildes, exactly as passed to the pipe2(2) system call.
flags	The original flags, exactly as passed to the pipe2(2) system call.

Definition at line 48 of file pipe2.c.

static void explain_buffer_errno_pipe2_system_call	(	explain_string_buffer_t *	sb,
		int	errnum,
		int *	fildes,
		int	flags
	)		[static]

Definition at line 35 of file pipe2.c.