libexplain/lchownat_or_die.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/lchownat.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
void	explain_lchownat_or_die (int fildes, const char *pathname, int uid, int gid)
int	explain_lchownat_on_error (int fildes, const char *pathname, int uid, int gid)

---

Function Documentation

int explain_lchownat_on_error	(	int	fildes,
		const char *	pathname,
		int	uid,
		int	gid
	)

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

Parameters:

fildes	The fildes, exactly as to be passed to the lchownat(2) system call.
pathname	The pathname, exactly as to be passed to the lchownat(2) system call.
uid	The uid, exactly as to be passed to the lchownat(2) system call.
gid	The gid, exactly as to be passed to the lchownat(2) system call.

Returns:

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

Example:

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

 if (explain_lchownat_on_error(fildes, pathname, uid, gid) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 36 of file lchownat_or_die.c.

void explain_lchownat_or_die	(	int	fildes,
		const char *	pathname,
		int	uid,
		int	gid
	)

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

Parameters:

fildes	The fildes, exactly as to be passed to the lchownat(2) system call.
pathname	The pathname, exactly as to be passed to the lchownat(2) system call.
uid	The uid, exactly as to be passed to the lchownat(2) system call.
gid	The gid, exactly as to be passed to the lchownat(2) system call.

Returns:

This function only returns on success, see lchownat(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_lchownat_or_die(fildes, pathname, uid, gid);

Definition at line 26 of file lchownat_or_die.c.