libexplain/message/adjtime.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/adjtime.h>

Go to the source code of this file.

Functions
void	explain_message_adjtime (char *message, int message_size, const struct timeval *delta, struct timeval *olddelta)

---

Function Documentation

void explain_message_adjtime	(	char *	message,
		int	message_size,
		const struct timeval *	delta,
		struct timeval *	olddelta
	)

The explain_message_adjtime function is used to obtain an explanation of an error returned by the adjtime(2) system call. The least the message will contain is the value of strerror(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

The errno global variable will be used to obtain the error value to be decoded.

Parameters:

message	The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
message_size	The size in bytes of the location in which to store the returned message.
delta	The original delta, exactly as passed to the adjtime(2) system call.
olddelta	The original olddelta, exactly as passed to the adjtime(2) system call.

Example:

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

 if (adjtime(delta, olddelta) < 0)
 {
     char message[3000];
     explain_message_adjtime(message, sizeof(message), delta, olddelta);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_adjtime_or_die function.

Definition at line 25 of file adjtime.c.