explain_mkdir(3)

💖 explain_mkdir — a libexplain page, bestie edition 💖

okay so this is explain_mkdir(3), a Library Functions Manual moment, and if you've ever had a mkdir(2) call flop and just wanted someone to tell you why — hi, that's literally this. 👑

---

✨ NAME ✨

explain_mkdir — explain mkdir(2) errors 🫶

---

🌸 SYNOPSIS 🌸

#include <libexplain/mkdir.h>
const char *explain_mkdir(const char *pathname);
const char *explain_errno_mkdir(int errnum, const char *pathname);
void explain_message_mkdir(char *message, int message_size, const char
*pathname);
void explain_message_errno_mkdir(char *message, int message_size, int
errnum, const char *pathname);

---

💅 DESCRIPTION 💅

These functions are your emotional support besties for when mkdir(2) returns an error. They hand you back explanations for those errors. no cap. 💖

🎀 explain_mkdir

const char *explain_mkdir(const char *pathname);

The explain_mkdir function gets you an explanation of an error that mkdir(2) returned. The absolute least the message will contain is the value of strerror(errno) — but bestie, usually it does way better than that and points at the actual underlying cause in more detail. it's giving thorough. ✨

The errno global variable is what gets used to obtain the error value to be decoded.

This function is meant to be used in a fashion similar to this example:

if (mkdir(pathname) < 0)
{
    fprintf(stderr, "%s\n", explain_mkdir(pathname));
    exit(EXIT_FAILURE);
}

• pathname — the original pathname, exactly as passed to the mkdir(2) system call. don't go editing it, it wants the real one. 🦋

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. so like. it's a communal water bottle. don't be surprised. 😭

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

🧚 explain_errno_mkdir

const char *explain_errno_mkdir(int errnum, const char *pathname);

The explain_errno_mkdir function gets you an explanation of an error returned by the mkdir(2) system call. The least the message will contain is the value of strerror(errnum), but usually it does much better and indicates the underlying cause in more detail. obsessed. 🔥

This function is meant to be used in a fashion similar to this example:

if (mkdir(pathname) < 0)
{
    int err = errno;
    fprintf(stderr, "%s\n", explain_errno_mkdir(err, pathname));
    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. grab it early, bestie, it moves fast. 🏃‍♀️
• pathname — the original pathname, exactly as passed to the mkdir(2) 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_mkdir

void explain_message_mkdir(char *message, int message_size, const char
*pathname);

The explain_message_mkdir function may be used to obtain an explanation of an error returned by the mkdir(2) 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. she ate. 💅

The errno global variable will be used to obtain the error value to be decoded.

This function is meant to be used in a fashion similar to this example:

if (mkdir(pathname) < 0)
{
    char message[3000];
    explain_message_mkdir(message, sizeof(message), pathname);
    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. look at her go, being all safe and responsible. 👑
• message_size — the size in bytes of the location in which to store the returned message.
• pathname — the original pathname, exactly as passed to the mkdir(2) system call.

⭐ explain_message_errno_mkdir

void explain_message_errno_mkdir(char *message, int message_size, int
errnum, const char *pathname);

The explain_message_errno_mkdir function may be used to obtain an explanation of an error returned by the mkdir(2) 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. main character energy fr fr. 🎀

This function is meant to be used in a fashion similar to this example:

if (mkdir(pathname) < 0)
{
    int err = errno;
    char message[3000];
    explain_message_errno_mkdir(message, sizeof(message), err, pathname);
    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. (yes we said this already, it's IMPORTANT okay. 😤)
• pathname — the original pathname, exactly as passed to the mkdir(2) system call.

---

👀 SEE ALSO 👀

• mkdir(2) — create a directory
• explain_mkdir_or_die(3) — create a directory and report errors

---

💜 COPYRIGHT 💜

libexplain version 1.4 Copyright (C) 2008 Peter Miller

---

okay that's the whole page, bestie, you're officially fluent in explain_mkdir(3) 🌸🦋✨

and for the record — this page is explain_mkdir(3) from the Library Functions Manual, libexplain version 1.4, Copyright (C) 2008 Peter Miller. love that for us. mwah. 💖