explain_fchown man page

explain_fchown — explain fchown(2) errors

Synopsis

#include <libexplain/fchown.h>

const char *explain_fchown(int fildes, int owner, int group);
const char *explain_errno_fchown(int errnum, int fildes, int owner, int group);
void explain_message_fchown(char *message, int message_size, int fildes, int owner, int group);
void explain_message_errno_fchown(char *message, int message_size, int errnum, int fildes, int owner, int group);

Description

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

explain_fchown

const char *explain_fchown(int fildes, int owner, int group);

The explain_fchown function is used to obtain an explanation of an error returned by the fchown(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 (fchown(fildes, owner, group) < 0)
{
    fprintf(stderr, "%s\n", explain_fchown(fildes, owner, group));
    exit(EXIT_FAILURE);
}

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

fildes

The original fildes, exactly as passed to the fchown(2) system call.

owner

The original owner, exactly as passed to the fchown(2) system call.

group

The original group, exactly as passed to the fchown(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_errno_fchown

const char *explain_errno_fchown(int errnum, int fildes, int owner, int group);

The explain_errno_fchown function is used to obtain an explanation of an error returned by the fchown(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 (fchown(fildes, owner, group) < 0)
{
    int err = errno;
    fprintf(stderr, "%s\n",
        explain_errno_fchown(err, fildes, owner, group));
    exit(EXIT_FAILURE);
}

The above code example is available pre-packaged as the explain_fchown_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.

fildes

The original fildes, exactly as passed to the fchown(2) system call.

owner

The original owner, exactly as passed to the fchown(2) system call.

group

The original group, exactly as passed to the fchown(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_fchown

void explain_message_fchown(char *message, int message_size, int fildes, int owner, int group);

The explain_message_fchown function may be used to  obtain an explanation of an error returned by the fchown(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 (fchown(fildes, owner, group) < 0)
{
    char message[3000];
    explain_message_fchown(message, sizeof(message), fildes, owner, group);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

The above code example is available pre-packaged as the explain_fchown_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.

fildes

The original fildes, exactly as passed to the fchown(2) system call.

owner

The original owner, exactly as passed to the fchown(2) system call.

group

The original group, exactly as passed to the fchown(2) system call.

explain_message_errno_fchown

void explain_message_errno_fchown(char *message, int message_size, int errnum, int fildes, int owner, int group);

The explain_message_errno_fchown function may be used to obtain an explanation of an error returned by the fchown(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 (fchown(fildes, owner, group) < 0)
{
    int err = errno;
    char message[3000];
    explain_message_errno_fchown(message, sizeof(message),
        err, fildes, owner, group);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

The above code example is available pre-packaged as the explain_fchown_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.

fildes

The original fildes, exactly as passed to the fchown(2) system call.

owner

The original owner, exactly as passed to the fchown(2) system call.

group

The original group, exactly as passed to the fchown(2) system call.

See Also

fchown(2)

change ownership of a file

explain_fchown_or_die(3)

change ownership of a file and report errors

Referenced By

explain(3), explain_fchown_or_die(3).