libexplain/acl_set_file.h File Reference

explain acl_set_file(3) errors More...

#include <libexplain/gcc_attributes.h>
#include <libexplain/large_file_support.h>
#include <sys/acl.h>

Go to the source code of this file.

Functions
void	explain_acl_set_file_or_die (const char *pathname, acl_type_t type, acl_t acl)
int	explain_acl_set_file_on_error (const char *pathname, acl_type_t type, acl_t acl)
const char *	explain_acl_set_file (const char *pathname, acl_type_t type, acl_t acl) LIBEXPLAIN_WARN_UNUSED_RESULT
const char *	explain_errno_acl_set_file (int errnum, const char *pathname, acl_type_t type, acl_t acl) LIBEXPLAIN_WARN_UNUSED_RESULT
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)

---

Detailed Description

explain acl_set_file(3) errors

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

Definition in file acl_set_file.h.

---

Function Documentation

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.

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

Parameters:

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)
 {
     explain_output_error_and_die("%s\n", explain_acl_set_file(pathname,
         type, acl));
 }

The above code example is available pre\-packaged as the explain_acl_set_file_or_die function.

int explain_acl_set_file_on_error	(	const char *	pathname,
		acl_type_t	type,
		acl_t	acl
	)

The explain_acl_set_file_on_error function is used to call the acl_set_file(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_acl_set_file(3) function.

Parameters:

pathname	The pathname, exactly as to be passed to the acl_set_file(3) system call.
type	The type, exactly as to be passed to the acl_set_file(3) system call.
acl	The acl, exactly as to be passed to the acl_set_file(3) system call.

Returns:

The value returned by the wrapped acl_set_file(3) system call.

Example:

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

 if (explain_acl_set_file_on_error(pathname, type, acl) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

void explain_acl_set_file_or_die	(	const char *	pathname,
		acl_type_t	type,
		acl_t	acl
	)

The explain_acl_set_file_or_die function is used to call the acl_set_file(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_acl_set_file(3) function, and then the process terminates by calling exit(EXIT_FAILURE).

Parameters:

pathname	The pathname, exactly as to be passed to the acl_set_file(3) system call.
type	The type, exactly as to be passed to the acl_set_file(3) system call.
acl	The acl, exactly as to be passed to the acl_set_file(3) system call.

Returns:

This function only returns on success, see acl_set_file(3) for more information. On failure, prints an explanation and exits, it does not return.

Example:

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

 explain_acl_set_file_or_die(pathname, type, acl);

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(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

Parameters:

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.

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 function.

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(errnum), 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.

Parameters:

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.
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 function.

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(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

Parameters:

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 function.