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.Dd August 10, 2018 31.Dt TIMESPEC_GET 3 32.Os 33.Sh NAME 34.Nm timespec_get 35.Nd get current calendar time 36.Sh LIBRARY 37.Lb libc 38.Sh SYNOPSIS 39.In time.h 40.Ft int 41.Fn timespec_get "struct timespec *ts" "int base" 42.Sh DESCRIPTION 43The 44.Nm 45function sets the interval pointed to by 46.Fa ts 47to hold the current calendar time based on the specified time base in 48.Fa base . 49.Pp 50The base 51.Dv TIME_UTC 52returns the time since the epoch. 53This time is expressed in seconds and nanoseconds since midnight (0 hour), January 1, 1970. 54In 55.Fx , 56this corresponds to 57.Dv CLOCK_REALTIME . 58.Sh RETURN VALUES 59The 60.Nm 61function returns the passed value of 62.Fa base 63if successful, otherwise 64.Dv 0 65on failure. 66.Sh SEE ALSO 67.Xr clock_gettime 2 , 68.Xr gettimeofday 2 , 69.Xr time 3 70.Sh STANDARDS 71The 72.Nm 73function with a 74.Fa base 75of 76.Dv TIME_UTC 77conforms to 78.St -isoC-2011 . 79.Sh HISTORY 80This interface first appeared in 81.Fx 12 . 82.Sh AUTHORS 83.An Kamil Rytarowski Aq Mt kamil@NetBSD.org 84.An Warner Losh Aq Mt imp@FreeBSD.org 85