libexplain/fchownat_or_die.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/unistd.h>
#include <libexplain/fchownat.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
void	explain_fchownat_or_die (int dirfd, const char *pathname, int owner, int group, int flags)
int	explain_fchownat_on_error (int dirfd, const char *pathname, int owner, int group, int flags)

---

Function Documentation

int explain_fchownat_on_error	(	int	dirfd,
		const char *	pathname,
		int	owner,
		int	group,
		int	flags
	)

The explain_fchownat_on_error function is used to call the fchownat(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_fchownat(3) function.

Parameters:

dirfd	The dirfd, exactly as to be passed to the fchownat(2) system call.
pathname	The pathname, exactly as to be passed to the fchownat(2) system call.
owner	The owner, exactly as to be passed to the fchownat(2) system call.
group	The group, exactly as to be passed to the fchownat(2) system call.
flags	The flags, exactly as to be passed to the fchownat(2) system call.

Returns:

The value returned by the wrapped fchownat(2) system call.

Example:

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

 if (explain_fchownat_on_error(dirfd, pathname, owner, group, flags) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 38 of file fchownat_or_die.c.

void explain_fchownat_or_die	(	int	dirfd,
		const char *	pathname,
		int	owner,
		int	group,
		int	flags
	)

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

Parameters:

dirfd	The dirfd, exactly as to be passed to the fchownat(2) system call.
pathname	The pathname, exactly as to be passed to the fchownat(2) system call.
owner	The owner, exactly as to be passed to the fchownat(2) system call.
group	The group, exactly as to be passed to the fchownat(2) system call.
flags	The flags, exactly as to be passed to the fchownat(2) system call.

Returns:

This function only returns on success, see fchownat(2) 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_fchownat_or_die(dirfd, pathname, owner, group, flags);

Definition at line 27 of file fchownat_or_die.c.