explain_getcwd(3)

💖 explain_getcwd — bestie, let's decode those getcwd(2) errors 💖

okay so this is explain_getcwd(3), a page from the Library Functions Manual, and it's literally all about making getcwd(2) errors make sense instead of just yelling "nope" at you. no cap. 🦋

---

✨ NAME ✨

explain_getcwd — explain getcwd(2) errors 💅

---

🌸 SYNOPSIS 🌸

#include <libexplain/getcwd.h>
const char *explain_getcwd(char *buf, size_t size);
const char *explain_errno_getcwd(int errnum, char *buf, size_t size);
void explain_message_getcwd(char *message, int message_size, char *buf,
size_t size);
void explain_message_errno_getcwd(char *message, int message_size, int
errnum, char *buf, size_t size);

---

👑 DESCRIPTION 👑

These functions may be used to obtain explanations for errors returned by the getcwd(2) system call. it's giving error translation services, and honestly? iconic. ✨

🎀 explain_getcwd

const char *explain_getcwd(char *buf, size_t size);

The explain_getcwd function is used to obtain an explanation of an error returned by the getcwd(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. like, it actually tells you why. obsessed. 💖

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 (getcwd(buf, size) < 0)
{
    fprintf(stderr, "%s\n", explain_getcwd(buf, size));
    exit(EXIT_FAILURE);
}

The above code example is available pre‐packaged as the explain_getcwd_or_die(3) function.

• buf — The original buf, exactly as passed to the getcwd(2) system call.
• size — The original size, exactly as passed to the getcwd(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. fr fr, watch out.

🧚 explain_errno_getcwd

const char *explain_errno_getcwd(int errnum, char *buf, size_t size);

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

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

if (getcwd(buf, size) < 0)
{
    int err = errno;
    fprintf(stderr, "%s\n", explain_errno_getcwd(err, buf, size));
    exit(EXIT_FAILURE);
}

The above code example is available pre‐packaged as the explain_getcwd_or_die(3) function.

• 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. 🙈
• buf — The original buf, exactly as passed to the getcwd(2) system call.
• size — The original size, exactly as passed to the getcwd(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_getcwd

void explain_message_getcwd(char *message, int message_size, char *buf,
size_t size);

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

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 (getcwd(buf, size) < 0)
{
    char message[3000];
    explain_message_getcwd(message, sizeof(message), buf, size);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

The above code example is available pre‐packaged as the explain_getcwd_or_die(3) function.

• message — The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe. 🫶 (bestie, you brought your own buffer, so you're safe!)
• message_size — The size in bytes of the location in which to store the returned message.
• buf — The original buf, exactly as passed to the getcwd(2) system call.
• size — The original size, exactly as passed to the getcwd(2) system call.

🌈 explain_message_errno_getcwd

void explain_message_errno_getcwd(char *message, int message_size, int
errnum, char *buf, size_t size);

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

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

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

The above code example is available pre‐packaged as the explain_getcwd_or_die(3) function.

• 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. 😭
• buf — The original buf, exactly as passed to the getcwd(2) system call.
• size — The original size, exactly as passed to the getcwd(2) system call.

---

🦋 SEE ALSO 🦋

• getcwd(2) — Get current working directory
• explain_getcwd_or_die(3) — Get current working directory and report errors

---

💜 COPYRIGHT 💜

libexplain version 1.4 Copyright (C) 2008 Peter Miller

---

and that's the whole page, bestie!! 🫶 this was explain_getcwd(3) from the Library Functions Manual, libexplain version 1.4, Copyright (C) 2008 Peter Miller — go forth and decode your errors, you absolute icon. 💖✨👑