libexplain/openat_or_die.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/fcntl.h>
#include <libexplain/openat.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
int	explain_openat_or_die (int fildes, const char *pathname, int flags, mode_t mode)
int	explain_openat_on_error (int fildes, const char *pathname, int flags, mode_t mode)

---

Function Documentation

int explain_openat_on_error	(	int	fildes,
		const char *	pathname,
		int	flags,
		mode_t	mode
	)

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

Parameters:

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

Returns:

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

Example:

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

 int result = explain_openat_on_error(fildes, pathname, flags, mode);
 if (result < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 41 of file openat_or_die.c.

int explain_openat_or_die	(	int	fildes,
		const char *	pathname,
		int	flags,
		mode_t	mode
	)

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

Parameters:

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

Returns:

This function only returns on success, see openat(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:

 int result = explain_openat_or_die(fildes, pathname, flags, mode);

Definition at line 27 of file openat_or_die.c.