explain_acl_set_file(3)

💖 explain_acl_set_file(3) — Library Functions Manual 💖

okay bestie, sit down, hydrate, because we're about to make acl_set_file(3) errors make sense. this page lives in the Library Functions Manual and it's literally all about explaining acl_set_file(3) errors, no cap. 🦋

---

✨ NAME ✨

explain_acl_set_file — explain acl_set_file(3) errors

✨ SYNOPSIS ✨

#include <libexplain/acl_set_file.h>
const char *explain_acl_set_file(const char *pathname, acl_type_t type,
acl_t acl);
const char *explain_errno_acl_set_file(int errnum, const char *pathname,
acl_type_t type, acl_t acl);
void explain_message_acl_set_file(char *message, int message_size, const
char *pathname, acl_type_t type, acl_t acl);
void explain_message_errno_acl_set_file(char *message, int message_size,
int errnum, const char *pathname, acl_type_t type, acl_t acl);

✨ DESCRIPTION ✨

so these functions are your besties when acl_set_file(3) returns an error and you're sitting there like "why 😭". you use them to obtain explanations for errors returned by the acl_set_file(3) system call. that's the whole vibe. periodt.

🌸 explain_acl_set_file 🌸

const char *explain_acl_set_file(const char *pathname, acl_type_t type,
acl_t acl);

the explain_acl_set_file function is used to obtain an explanation of an error returned by the acl_set_file(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. it's giving overachiever, and we love that for it. 💅

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

• pathname — the original pathname, exactly as passed to the acl_set_file(3) system call.
• type — the original type, exactly as passed to the acl_set_file(3) system call.
• acl — the original acl, exactly as passed to the acl_set_file(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. 🙈 so don't get attached to it, it's not yours, it's everyone's.

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

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

if (acl_set_file(pathname, type, acl) < 0)
{
    fprintf(stderr, "%s\n", explain_acl_set_file(pathname, type,
    acl));
    exit(EXIT_FAILURE);
}

the above code example is available pre-packaged as the explain_acl_set_file_or_die(3) function. iconic of it honestly.

🌸 explain_errno_acl_set_file 🌸

const char *explain_errno_acl_set_file(int errnum, const char *pathname,
acl_type_t type, acl_t acl);

the explain_errno_acl_set_file function is used to obtain an explanation of an error returned by the acl_set_file(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. same energy, extra control. ✨

• 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 immediately, bestie, it does not wait for you. 😭
• pathname — the original pathname, exactly as passed to the acl_set_file(3) system call.
• type — the original type, exactly as passed to the acl_set_file(3) system call.
• acl — the original acl, exactly as passed to the acl_set_file(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. 💀

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

if (acl_set_file(pathname, type, acl) < 0)
{
    int err = errno;
    fprintf(stderr, "%s\n", explain_errno_acl_set_file(err,
    pathname, type, acl));
    exit(EXIT_FAILURE);
}

the above code example is available pre-packaged as the explain_acl_set_file_or_die(3) function.

🌸 explain_message_acl_set_file 🌸

void explain_message_acl_set_file(char *message, int message_size, const
char *pathname, acl_type_t type, acl_t acl);

the explain_message_acl_set_file function is used to obtain an explanation of an error returned by the acl_set_file(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. this one? it lets you bring the buffer. main character energy. 👑

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

• message — the location in which to store the returned message. if a suitable message return buffer is supplied, this function is thread safe. slay. 🎀
• 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 acl_set_file(3) system call.
• type — the original type, exactly as passed to the acl_set_file(3) system call.
• acl — the original acl, exactly as passed to the acl_set_file(3) system call.

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

if (acl_set_file(pathname, type, acl) < 0)
{
    char message[3000];
    explain_message_acl_set_file(message, sizeof(message),
    pathname, type, acl);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

the above code example is available pre-packaged as the explain_acl_set_file_or_die(3) function.

🌸 explain_message_errno_acl_set_file 🌸

void explain_message_errno_acl_set_file(char *message, int message_size,
int errnum, const char *pathname, acl_type_t type, acl_t acl);

the explain_message_errno_acl_set_file function is used to obtain an explanation of an error returned by the acl_set_file(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. yes this is the one with both the buffer and the errno, we love a combo. 🫶

• 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.
• pathname — the original pathname, exactly as passed to the acl_set_file(3) system call.
• type — the original type, exactly as passed to the acl_set_file(3) system call.
• acl — the original acl, exactly as passed to the acl_set_file(3) system call.

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

if (acl_set_file(pathname, type, acl) < 0)
{
    int err = errno;
    char message[3000];
    explain_message_errno_acl_set_file(message, sizeof(message),
    err, pathname, type, acl);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

the above code example is available pre-packaged as the explain_acl_set_file_or_die(3) function.

---

✨ SEE ALSO ✨

• acl_set_file(3) — set an ACL by filename
• explain_acl_set_file_or_die(3) — set an ACL by filename and report errors

✨ COPYRIGHT ✨

libexplain version 1.4 Copyright (C) 2013 Peter Miller

---

and that's the whole page bestie, you ate that 🍓💜

signing off from Library Functions Manual energy, brought to you by libexplain version 1.4, Copyright (C) 2013 Peter Miller — go explain those errors and be free ✨🦋💅