ntp_gettime

- get local clock values

Synopsis

#include <sys/timex.h>

int ntp_gettime(struct ntptimeval *tptr);

Description

The ntp_gettime() function reads the local clock value and dispersion, returning the information in tptr.

The ntptimeval structure contains the following members:

struct ntptimeval {
    struct timeval   time;       /* current time (ro) */
    int32_t          maxerror;   /* maximum error (us) (ro) */
    int32_t          esterror;   /* estimated error (us) (ro) */
};

Return Values

Upon successful completion, ntp_gettime() returns the current clock state (see <sys/timex.h>). Otherwise, it returns -1 and sets errno to indicate the error.

Errors

The ntp_gettime() function will fail if:

EFAULT

The tptr argument points to an invalid address.

The ntp_gettime() function will fail for 32-bit interfaces if:

EOVERFLOW

The size of the time.tv_sec member of the ntptimeval structure pointed to by tptr is too small to contain the correct number of seconds.

See Also

xntpd(1M), ntp_adjtime(2)