libexplain/adjtime_on_error.c File Reference

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

Go to the source code of this file.

Functions
int	explain_adjtime_on_error (const struct timeval *delta, struct timeval *olddelta)

---

Function Documentation

int explain_adjtime_on_error	(	const struct timeval *	delta,
		struct timeval *	olddelta
	)

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

Parameters:

delta	The delta, exactly as to be passed to the adjtime(2) system call.
olddelta	The olddelta, exactly as to be passed to the adjtime(2) system call.

Returns:

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

Example:

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

 if (explain_adjtime_on_error(delta, olddelta) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 27 of file adjtime_on_error.c.