explain_tcgetattr(3)

💖 explain_tcgetattr — bestie edition 💖

okay so this is explain_tcgetattr(3), from the Library Functions Manual, and it's literally the glow-up your error messages have been begging for. it's all about explaining tcgetattr(3) errors so you actually know what went wrong instead of just staring at a sad little -1. 🦋

---

✨ NAME ✨

explain_tcgetattr — explain tcgetattr(3) errors 💅

---

✨ SYNOPSIS ✨

#include <libexplain/tcgetattr.h>
const char *explain_tcgetattr(int fildes, struct termios *data);
const char *explain_errno_tcgetattr(int errnum, int fildes, struct
termios *data);
void explain_message_tcgetattr(char *message, int message_size, int
fildes, struct termios *data);
void explain_message_errno_tcgetattr(char *message, int message_size,
int errnum, int fildes, struct termios *data);

---

🌸 DESCRIPTION 🌸

so these functions are your little translators, bestie. they take the errors that come back from the tcgetattr(3) system call and turn them into actual explanations. no cap. 🫶

---

🎀 explain_tcgetattr 🎀

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

the explain_tcgetattr function gets you an explanation of an error that came back from the tcgetattr(3) system call. the absolute bare minimum the message will have is the value of strerror(errno), but lowkey it usually does way better than that and tells you the actual underlying cause in more detail. ✨

it pulls the error value it needs to decode from the errno global variable. periodt.

• fildes — the original fildes, exactly as passed to the tcgetattr(3) system call.
• data — the original data, exactly as passed to the tcgetattr(3) system call.

Returns:

the message explaining the error. this message buffer is shared by all libexplain functions that don't supply a buffer in their argument list. so it will get overwritten by the next call to any libexplain function that shares this buffer — including from other threads. 💀

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

Example: this function is meant to be used in a fashion similar to the following example:

if (tcgetattr(fildes, data) < 0)
{
    fprintf(stderr, "%s\n", explain_tcgetattr(fildes, data));
    exit(EXIT_FAILURE);
}

the above code example is available pre‐packaged as the explain_tcgetattr_or_die(3) function. iconic. 👑

---

🎀 explain_errno_tcgetattr 🎀

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

the explain_errno_tcgetattr function gets you an explanation of an error that came back from the tcgetattr(3) system call. the least the message will contain is the value of strerror(errno), but usually it does much better and shows you the underlying cause in more detail. 🌈

• errnum — the error value to be decoded, usually grabbed from the errno global variable right before this function is called. this is necessary if you need to run any code between the system call you're explaining and this function, because a lot of libc functions will alter the value of errno. 🙈
• fildes — the original fildes, exactly as passed to the tcgetattr(3) system call.
• data — the original data, exactly as passed to the tcgetattr(3) system call.

Returns:

the message explaining the error. this message buffer is shared by all libexplain functions that don't supply a buffer in their argument list. it will be overwritten by the next call to any libexplain function that 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 do too.

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

if (tcgetattr(fildes, data) < 0)
{
    int err = errno;
    fprintf(stderr, "%s\n", explain_errno_tcgetattr(err, fildes,
    data));
    exit(EXIT_FAILURE);
}

the above code example is available pre‐packaged as the explain_tcgetattr_or_die(3) function. slay. 💅

---

🎀 explain_message_tcgetattr 🎀

void explain_message_tcgetattr(char *message, int message_size, int
fildes, struct termios *data);

the explain_message_tcgetattr function gets you an explanation of an error returned by the tcgetattr(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 tcgetattr(3) system call.
• data — the original data, exactly as passed to the tcgetattr(3) system call.

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

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

the above code example is available pre‐packaged as the explain_tcgetattr_or_die(3) function. 💖

---

🎀 explain_message_errno_tcgetattr 🎀

void explain_message_errno_tcgetattr(char *message, int message_size,
int errnum, int fildes, struct termios *data);

the explain_message_errno_tcgetattr function gets you an explanation of an error returned by the tcgetattr(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 tcgetattr(3) system call.
• data — the original data, exactly as passed to the tcgetattr(3) system call.

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

if (tcgetattr(fildes, data) < 0)
{
    int err = errno;
    char message[3000];
    explain_message_errno_tcgetattr(message, sizeof(message),
    err, fildes, data);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

the above code example is available pre‐packaged as the explain_tcgetattr_or_die(3) function. 🎀

---

🦋 SEE ALSO 🦋

• tcgetattr(3) — get terminal parameters
• explain_tcgetattr_or_die(3) — get terminal parameters and report errors

---

👑 COPYRIGHT 👑

libexplain version 1.4 Copyright (C) 2009 Peter Miller

---

okay that's the whole page, bestie!! go forth and explain your tcgetattr(3) errors like the main character you are 🌸✨ and yeah — that's libexplain version 1.4, Copyright (C) 2009 Peter Miller, from the Library Functions Manual, mwah 💜