libexplain/utimensat_or_die.c File Reference

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

Go to the source code of this file.

Functions
void	explain_utimensat_or_die (int fildes, const char *pathname, const struct timespec *data, int flags)
static int	utimensat (int fildes, const char *pathname, const struct timespec *data, int flags)
int	explain_utimensat_on_error (int fildes, const char *pathname, const struct timespec *data, int flags)

---

Function Documentation

int explain_utimensat_on_error	(	int	fildes,
		const char *	pathname,
		const struct timespec *	data,
		int	flags
	)

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

Parameters:

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

Returns:

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

Example:

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

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

Definition at line 56 of file utimensat_or_die.c.

void explain_utimensat_or_die	(	int	fildes,
		const char *	pathname,
		const struct timespec *	data,
		int	flags
	)

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

Parameters:

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

Returns:

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

Definition at line 28 of file utimensat_or_die.c.

static int utimensat	(	int	fildes,
		const char *	pathname,
		const struct timespec *	data,
		int	flags
	)		[static]

Definition at line 41 of file utimensat_or_die.c.