libexplain/buffer/errno/tcsetattr.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/buffer/ebadf.h>
#include <libexplain/buffer/einval.h>
#include <libexplain/buffer/enosys.h>
#include <libexplain/buffer/errno/generic.h>
#include <libexplain/buffer/errno/tcsetattr.h>
#include <libexplain/buffer/fildes.h>
#include <libexplain/buffer/is_the_null_pointer.h>
#include <libexplain/buffer/tcsetattr_options.h>
#include <libexplain/buffer/termios.h>
#include <libexplain/explanation.h>

Go to the source code of this file.

Functions
static void	explain_buffer_errno_tcsetattr_system_call (explain_string_buffer_t *sb, int errnum, int fildes, int options, const struct termios *data)
void	explain_buffer_errno_tcsetattr_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, int fildes, int options, const struct termios *data)
void	explain_buffer_errno_tcsetattr (explain_string_buffer_t *sb, int errnum, int fildes, int options, const struct termios *data)

---

Function Documentation

void explain_buffer_errno_tcsetattr	(	explain_string_buffer_t *	sb,
		int	errnum,
		int	fildes,
		int	options,
		const struct termios *	data
	)

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

Definition at line 94 of file tcsetattr.c.

void explain_buffer_errno_tcsetattr_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		int	fildes,
		int	options,
		const struct termios *	data
	)

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

Definition at line 49 of file tcsetattr.c.

static void explain_buffer_errno_tcsetattr_system_call	(	explain_string_buffer_t *	sb,
		int	errnum,
		int	fildes,
		int	options,
		const struct termios *	data
	)		[static]

Definition at line 34 of file tcsetattr.c.