lib/libc/gen/timespec_get.3

   1 .\"     $NetBSD: timespec_get.3,v 1.2 2016/10/04 10:46:40 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 2016 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Kamil Rytarowski.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .\" $FreeBSD$
  31 .\"
  32 .Dd August 10, 2018
  33 .Dt TIMESPEC_GET 3
  34 .Os
  35 .Sh NAME
  36 .Nm timespec_get
  37 .Nd get current calendar time
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In time.h
  42 .Ft int
  43 .Fn timespec_get "struct timespec *ts" "int base"
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 function sets the interval pointed to by
  48 .Fa ts
  49 to hold the current calendar time based on the specified time base in
  50 .Fa base .
  51 .Pp
  52 The base
  53 .Dv TIME_UTC
  54 returns the time since the epoch.
  55 This time is expressed in seconds and nanoseconds since midnight (0 hour), January 1, 1970.
  56 In
  57 .Fx ,
  58 this corresponds to
  59 .Dv CLOCK_REALTIME .
  60 .Sh RETURN VALUES
  61 The
  62 .Nm
  63 function returns the passed value of
  64 .Fa base
  65 if successful, otherwise
  66 .Dv 0
  67 on failure.
  68 .Sh SEE ALSO
  69 .Xr gettimeofday 2 ,
  70 .Xr clock_gettime 2 ,
  71 .Xr time 3
  72 .Sh STANDARDS
  73 The
  74 .Nm
  75 function with a
  76 .Fa base
  77 of
  78 .Dv TIME_UTC
  79 conforms to
  80 .St -isoC-2011 .
  81 .Sh HISTORY
  82 This interface first appeared in
  83 .Fx 12 .
  84 .Sh AUTHORS
  85 .An Kamil Rytarowski Aq Mt kamil@NetBSD.org
  86 .An Warner Losh Aq Mt imp@FreeBSD.org