Index for Section 3

Alphabetical listing for S

Bottom of page

setclock(3)
NAME
  setclock - Sets value of system-wide clock

LIBRARY
  Standard C Library (libc.a)

SYNOPSIS
  #include <sys/timers.h>
  int setclock(
	  int clktyp,
	  struct timespec *val) ;

PARAMETERS
  clktyp    Specifies a system-wide clock whose symbolic name must be
	    TIMEOFDAY.

  val	    Points to the location where the value of the time to set into
	    the clock specified by the clktyp parameter is stored.

DESCRIPTION
  The setclock() function sets a time value into the system-wide clock whose
  symbolic name is specified by the clktyp parameter, which must be
  TIMEOFDAY, defined in the sys/timers.h header file.

  The source of the current value of time set into the system-wide time-of-
  day clock by this function is stored in space reserved by a type timespec
  structure pointed to by the val parameter. This time information is the
  amount of time since the epoch. The epoch is referenced to 00:00:00 GMT
  (Greenwich Mean Time) 1 Jan 1970. The timespec structure, which is also
  defined in the sys/timers.h header file has the following members:
  unsigned long	   tv_sec   Time of day since the epoch in seconds.
	   long	  tv_nsec

			    Time of day fraction of a second
			    (expressed in nanoseconds).

NOTES
  AES Support Level:
		 Trial use

RETURN VALUES
  Upon successful completion, the setclock() function returns a value of 0
  (zero).  Otherwise, a value of -1 is returned and errno is set to indicate
  the error.

ERRORS
  If the setclock() function fails, errno may be set to one of the following
  values:

  [EINVAL]  The clktyp parameter does not specify a known system-wide clock,
	    the information pointed to by the val parameter is outside the
	    permissible range for the clock specified by the clktyp
	    parameter, or a nanosecond value less than zero or greater than
	    or equal to 1000 million is specified by the information pointed
	    to by the val parameter.

  [EIO]	    An error occurred while accessing the clock specified by the
	    clktyp parameter.

  [EPERM]   The requesting process does not have the appropriate privilege to
	    set the clock specified by the clktyp parameter.

RELATED INFORMATION
  Functions: getclock(3), gettimer(3), time(3)

Index for Section 3

Alphabetical listing for S

Top of page