libexplain/message/tcsetattr.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/tcsetattr.h>

Go to the source code of this file.

Functions
void	explain_message_tcsetattr (char *message, int message_size, int fildes, int options, const struct termios *data)

---

Function Documentation

void explain_message_tcsetattr	(	char *	message,
		int	message_size,
		int	fildes,
		int	options,
		const struct termios *	data
	)

The explain_message_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.

The errno global variable will be used to obtain the error value to be decoded.

Parameters:

message	The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
message_size	The size in bytes of the location in which to store the returned message.
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.

Example:

This function is intended to be used in a fashion similar to the following example:

 if (tcsetattr(fildes, options, data) < 0)
 {
     char message[3000];
     explain_message_tcsetattr(message, sizeof(message), fildes, options,
         data);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_tcsetattr_or_die function.

Definition at line 25 of file tcsetattr.c.