explain_tcdrain_or_die(3)

💖 NAME 💖

okay bestie, come sit, we're reading explain_tcdrain_or_die(3) together — it's from the Library Functions Manual and honestly it's giving "small function, huge personality". 💅

explain_tcdrain_or_die — Execute tcdrain(3) and report errors. that's the whole name, no cap. ✨

---

🎀 SYNOPSIS 🎀

#include <libexplain/tcdrain.h>
void explain_tcdrain_or_die(int fildes);
int explain_tcdrain_on_error(int fildes);

two functions, one header, zero chaos (until something fails, and then all the chaos). 🌸

---

🦋 DESCRIPTION 🦋

so the explain_tcdrain_or_die function is literally just here to call the tcdrain(3) system call for you. that's her whole job. main character energy fr fr.

and when it fails? 😭 an explanation gets printed to stderr — she gets it from the explain_tcdrain(3) function — and then the process terminates by calling exit(EXIT_FAILURE). so like... she is not coming back. periodt. 💀

the explain_tcdrain_on_error function is the same situation, she calls the tcdrain(3) system call too, and on failure an explanation is printed to stderr, also obtained from the explain_tcdrain(3) function — but this one still returns to the caller. no exiting, no theatrics, she just comes home. 🫶

here's the one and only argument, bestie:

• fildes — the fildes, exactly as to be passed to the tcdrain(3) system call. like, don't get creative with it, hand it over the exact way tcdrain(3) wants it. 💜

---

⭐ RETURN VALUE ⭐

• explain_tcdrain_or_die only returns on success, and if you want the details on that, see tcdrain(3) for more information. on failure she prints an explanation and exits, so she does not return. she's gone, she's left the group chat. 🙈
• explain_tcdrain_on_error always returns the value return by the wrapped tcdrain(3) system call. every single time. iconic behavior. 👑

---

🌈 EXAMPLE 🌈

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

explain_tcdrain_or_die(fildes);

that's it. that's the example. short, sweet, slay. 💅

---

🔥 SEE ALSO 🔥

• tcdrain(3) — Execute tcdrain(3)
• explain_tcdrain(3) — explain tcdrain(3) errors
• exit(2) — terminate the calling process

---

👑 COPYRIGHT 👑

libexplain version 1.4

Copyright (C) 2009 Peter Miller,,,

---

okay that's the whole page bestie, we ate and left no crumbs 🍓 this was explain_tcdrain_or_die(3), brought to you by libexplain version 1.4 with Copyright (C) 2009 Peter Miller,,, — mwah 💋 stay hydrated, read your man pages, and may every single one of your tcdrain(3) calls return on success. bye!! 💖✨🎀🦋🌸🧚💜