libexplain/settimeofday_or_die.c File Reference

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

Go to the source code of this file.

Functions
void	explain_settimeofday_or_die (const struct timeval *tv, const struct timezone *tz)
int	explain_settimeofday_on_error (const struct timeval *tv, const struct timezone *tz)

---

Function Documentation

int explain_settimeofday_on_error	(	const struct timeval *	tv,
		const struct timezone *	tz
	)

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

Parameters:

tv	The tv, exactly as to be passed to the settimeofday(2) system call.
tz	The tz, exactly as to be passed to the settimeofday(2) system call.

Returns:

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

Example:

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

 if (explain_settimeofday_on_error(tv, tz) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 37 of file settimeofday_or_die.c.

void explain_settimeofday_or_die	(	const struct timeval *	tv,
		const struct timezone *	tz
	)

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

Parameters:

tv	The tv, exactly as to be passed to the settimeofday(2) system call.
tz	The tz, exactly as to be passed to the settimeofday(2) system call.

Returns:

This function only returns on success, see settimeofday(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_settimeofday_or_die(tv, tz);

Definition at line 27 of file settimeofday_or_die.c.