libexplain/fstatat_or_die.c File Reference

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

Go to the source code of this file.

Functions
void	explain_fstatat_or_die (int fildes, const char *pathname, struct stat *data, int flags)
int	explain_fstatat_on_error (int fildes, const char *pathname, struct stat *data, int flags)

---

Function Documentation

int explain_fstatat_on_error	(	int	fildes,
		const char *	pathname,
		struct stat *	data,
		int	flags
	)

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

Parameters:

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

Returns:

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

Example:

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

 if (explain_fstatat_on_error(fildes, pathname, data, flags) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 38 of file fstatat_or_die.c.

void explain_fstatat_or_die	(	int	fildes,
		const char *	pathname,
		struct stat *	data,
		int	flags
	)

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

Parameters:

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

Returns:

This function only returns on success, see fstatat(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_fstatat_or_die(fildes, pathname, data, flags);

Definition at line 27 of file fstatat_or_die.c.