libexplain/lchmod_or_die.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/sys/stat.h>
#include <libexplain/lchmod.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
void	explain_lchmod_or_die (const char *pathname, mode_t mode)
int	explain_lchmod_on_error (const char *pathname, mode_t mode)

---

Function Documentation

int explain_lchmod_on_error	(	const char *	pathname,
		mode_t	mode
	)

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

Parameters:

pathname	The pathname, exactly as to be passed to the lchmod(2) system call.
mode	The mode, exactly as to be passed to the lchmod(2) system call.

Returns:

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

Example:

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

 if (explain_lchmod_on_error(pathname, mode) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 37 of file lchmod_or_die.c.

void explain_lchmod_or_die	(	const char *	pathname,
		mode_t	mode
	)

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

Parameters:

pathname	The pathname, exactly as to be passed to the lchmod(2) system call.
mode	The mode, exactly as to be passed to the lchmod(2) system call.

Returns:

This function only returns on success, see lchmod(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_lchmod_or_die(pathname, mode);

Definition at line 27 of file lchmod_or_die.c.