libexplain/futimens_or_die.c File Reference

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

Go to the source code of this file.

Functions
void	explain_futimens_or_die (int fildes, const struct timespec *data)
int	explain_futimens_on_error (int fildes, const struct timespec *data)

---

Function Documentation

int explain_futimens_on_error	(	int	fildes,
		const struct timespec *	data
	)

The explain_futimens_on_error function is used to call the futimens(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_futimens(3) function.

Parameters:

fildes	The fildes, exactly as to be passed to the futimens(3) system call.
data	The data, exactly as to be passed to the futimens(3) system call.

Returns:

The value returned by the wrapped futimens(3) system call.

Example:

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

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

Definition at line 38 of file futimens_or_die.c.

void explain_futimens_or_die	(	int	fildes,
		const struct timespec *	data
	)

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

Parameters:

fildes	The fildes, exactly as to be passed to the futimens(3) system call.
data	The data, exactly as to be passed to the futimens(3) system call.

Returns:

This function only returns on success, see futimens(3) 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_futimens_or_die(fildes, data);

Definition at line 28 of file futimens_or_die.c.