explain_openat_or_die(3)

💖 explain_openat_or_die(3) 💖

okay bestie, so this one lives in the Library Functions Manual and it's literally called explain_openat_or_die — yes, the name is a whole mood, and yes, the "or_die" part is not a joke, we'll get there. 🫶

---

✨ NAME ✨

explain_openat_or_die — open a file relative to a dir fd and report errors 🦋

---

🌸 SYNOPSIS 🌸

#include <libexplain/openat.h>
int explain_openat_or_die(int fildes, const char *pathname, int flags,
       mode_t mode);
int explain_openat_on_error(int fildes, const char *pathname, int flags,
       mode_t mode);

---

👑 DESCRIPTION 👑

okay so here's the tea. 🍓

The explain_openat_or_die function is used to call the openat(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_openat(3) function, and then the process terminates by calling exit(EXIT_FAILURE). like, it really said "if this doesn't work we're not sticking around to find out." 💀

The explain_openat_on_error function is used to call the openat(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_openat(3) function, but still returns to the caller. so it tells you what went wrong and then just… hands the problem back to you. main character energy fr. ✨

• fildes — The fildes, exactly as to be passed to the openat(2) system call.
• pathname — The pathname, exactly as to be passed to the openat(2) system call.
• flags — The flags, exactly as to be passed to the openat(2) system call.
• mode — The mode, exactly as to be passed to the openat(2) system call.

---

🌈 RETURN VALUE 🌈

The explain_openat_or_die function only returns on success, see openat(2) for more information. On failure, prints an explanation and exits, it does not return. ngl "does not return" is giving final boss. 😭

The explain_openat_on_error function always returns the value return by the wrapped openat(2) system call.

---

🎀 EXAMPLE 🎀

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

int result = explain_openat_or_die(fildes, pathname, flags, mode);

look at that. one line. slay. 💅

---

🧚 SEE ALSO 🧚

• openat(2) — open a file relative to a directory file descriptor
• explain_openat(3) — explain openat(2) errors
• exit(2) — terminate the calling process

---

💜 COPYRIGHT 💜

libexplain version 1.4 Copyright (C) 2013 Peter Miller

---

and that's the whole page, bestie! 🦋✨ it came from libexplain version 1.4, the copyright belongs to Peter Miller all the way back in 2013, and the header up top says explain_openat_or_die(3) while the footer down bottom says explain_openat_or_die(3) right back at ya. periodt. 💅🎀