Content-type: text/html Man page of ntp_gettime

ntp_gettime

Section: System Calls (2)
Updated: 9 Nov 1999
Index Return to Main Contents
 

NAME

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)


 

Index

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUES
ERRORS
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:37:16 GMT, October 02, 2010