explain_tcsetattr(3)

NAME
explain_tcsetattr - explain tcsetattr(3) errors

SYNOPSIS
#include <libexplain/tcsetattr.h>

const char *explain_tcsetattr(int fildes, int options, const struct termios *data);
const char *explain_errno_tcsetattr(int errnum, int fildes, int options, const struct termios *data);
void explain_message_tcsetattr(char *message, int message_size, int fildes, int options, const struct termios *data);
void explain_message_errno_tcsetattr(char *message, int message_size, int errnum, int fildes, int options, const struct termios *data);

DESCRIPTION
These functions may be used to obtain explanations for errors returned by the tcsetattr(3) system call.

  explain_tcsetattr
const char *explain_tcsetattr(int fildes, int options, const struct termios *data);

The explain_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(errno), 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.

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.

Returns:
    The message explaining the error. This message buffer is shared by all libexplain functions which do not supply a buffer in their argument list. This will be overwritten by the next call to any libexplain function which shares this buffer, including other threads.

Note: This function is not thread safe, because it shares a return buffer across all threads, and many other functions in this library.

Example: This function is intended to be used in a fashion similar to the following example:
    if (tcsetattr(fildes, options, data) < 0)
    {
    fprintf(stderr, "%s\n", explain_tcsetattr(fildes, options, data));
        exit(EXIT_FAILURE);
    }

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

  explain_errno_tcsetattr
const char *explain_errno_tcsetattr(int errnum, int fildes, int options, const struct termios *data);

The explain_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(errno), but usually it will do much better, and indicate the underlying cause in more detail.

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.

Returns:
    The message explaining the error. This message buffer is shared by all libexplain functions which do not supply a buffer in their argument list. This will be overwritten by the next call to any libexplain function which shares this buffer, including other threads.

Note: This function is not thread safe, because it shares a return buffer across all threads, and many other functions in this library.

Example: This function is intended to be used in a fashion similar to the following example:
    if (tcsetattr(fildes, options, data) < 0)
    {
        int err = errno;
    fprintf(stderr, "%s\n", explain_errno_tcsetattr(err, fildes, options, data));
        exit(EXIT_FAILURE);
    }

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

  explain_message_tcsetattr
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(errno), 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.

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(3) function.

  explain_message_errno_tcsetattr
void explain_message_errno_tcsetattr(char *message, int message_size, int errnum, int fildes, int options, const struct termios *data);

The explain_message_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(errno), but usually it will do much better, and indicate the underlying cause in more detail.

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.

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.

Example: This function is intended to be used in a fashion similar to the following example:
    if (tcsetattr(fildes, options, data) < 0)
    {
        int err = errno;
        char message[3000];
    explain_message_errno_tcsetattr(message, sizeof(message), err, 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(3) function.

SEE ALSO

tcsetattr(3)
    set terminal attributes

explain_tcsetattr_or_die(3)
    set terminal attributes and report errors

COPYRIGHT
libexplain version
Copyright (C) 2009 Peter Miller