libexplain/gettimeofday_on_error.c File Reference

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

Go to the source code of this file.

Functions
int	explain_gettimeofday_on_error (struct timeval *tv, struct timezone *tz)

---

Function Documentation

int explain_gettimeofday_on_error	(	struct timeval *	tv,
		struct timezone *	tz
	)

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

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

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

Parameters:

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

Returns:

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

Definition at line 27 of file gettimeofday_on_error.c.