explain_settimeofday_or_die man page

explain_settimeofday_or_die — sets system time and report errors

Synopsis

#include <libexplain/settimeofday.h>

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);

Description

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).

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, but still returns to the caller.

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.

Return Value

The explain_settimeofday_or_die function only returns on success, see settimeofday(2) for more information. On failure, prints an explanation and exits, it does not return.

The explain_settimeofday_on_error function always returns the value return by the wrapped settimeofday(2) system call.

Example

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

explain_settimeofday_or_die(tv, tz);

See Also

settimeofday(2)
sets system time
explain_settimeofday(3)
explain settimeofday(2) errors
exit(2)
terminate the calling process

Referenced By

explain(3), explain_settimeofday(3).