explain_closedir(3)

💖 explain_closedir(3) — the glow-up 💖

okay bestie so this is the page for explain_closedir(3), which lives in the Library Functions Manual section, and it's all about explaining the errors you get back from closedir(3). think of it as the friend who translates "uh, that call failed" into "here's exactly why, and here's the vibe." 🫶

---

✨ NAME ✨

explain_closedir — explain closedir(3) errors. that's it, that's the whole job. 💅

---

🌸 SYNOPSIS 🌸

#include <libexplain/closedir.h>
const char *explain_closedir(DIR *dir);
const char *explain_errno_closedir(int errnum, DIR *dir);
void explain_message_closedir(char *message, int message_size, DIR *dir);
void explain_message_errno_closedir(char *message, int message_size, int errnum, DIR *dir);

four functions, one mission: tell you what actually went wrong. 👑

---

🦋 DESCRIPTION 🦋

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

like, you know how closedir(3) just goes "nope, -1" and leaves you on read? these functions are the ones that actually text back with the whole story. 📱💬

💜 explain_closedir

const char *explain_closedir(DIR *dir);

The explain_closedir function is used to obtain an explanation of an error returned by the closedir(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.

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

if (closedir(dir) < 0)
{
    fprintf(stderr, "%s\n", explain_closedir(dir));
    exit(EXIT_FAILURE);
}

• dir — The original dir, exactly as passed to the closedir(3) system call. no remixing, no editing, the literal same one. 🙈

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. it's giving communal, and not in a cute way. 😭

🎀 explain_errno_closedir

const char *explain_errno_closedir(int errnum, DIR *dir);

The explain_errno_closedir function is used to obtain an explanation of an error returned by the closedir(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.

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

if (closedir(dir) < 0)
{
    int err = errno;
    fprintf(stderr, "%s\n", explain_errno_closedir(err, dir));
    exit(EXIT_FAILURE);
}

• 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. so like, grab that errno early or it'll get sniped by some other libc function, fr fr. 💀
• dir — The original dir, exactly as passed to the closedir(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.

🌈 explain_message_closedir

void explain_message_closedir(char *message, int message_size, DIR *dir);

The explain_message_closedir function may be used to obtain an explanation of an error returned by the closedir(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.

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

if (closedir(dir) < 0)
{
    char message[3000];
    explain_message_closedir(message, sizeof(message), dir);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

• message — The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe. see? bring your own buffer and suddenly we're all chill. ✨
• message_size — The size in bytes of the location in which to store the returned message.
• dir — The original dir, exactly as passed to the closedir(3) system call.

🧚 explain_message_errno_closedir

void explain_message_errno_closedir(char *message, int message_size, int errnum, DIR *dir);

The explain_message_errno_closedir function may be used to obtain an explanation of an error returned by the closedir(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.

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

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

• 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.
• dir — The original dir, exactly as passed to the closedir(3) system call.

---

🔥 SEE ALSO 🔥

• closedir(3) — close a directory
• explain_closedir_or_die(3) — close a directory and report errors

iykyk, go read those next. 👑

---

👑 COPYRIGHT 👑

libexplain version 1.4 Copyright (C) 2008 Peter Miller

---

and that's the page, bestie 💖 the source/version is libexplain version 1.4, and the copyright sits with Peter Miller, 2008 — go off, legend. this whole thing was explain_closedir(3), and you absolutely ate that read. periodt. 🎀✨