xref: /netbsd-src/lib/libc/gen/timespec_get.3 (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
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 October 4, 2016
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.Vt #define TIME_UTC 1
41.Ft int
42.Fn timespec_get "struct timespec *ts" "int base"
43.Sh DESCRIPTION
44The
45.Nm
46function sets the interval pointed to by
47.Fa ts
48to hold the current calendar time based on the specified time base in
49.Fa base .
50.Pp
51Currently the only supported valid base is
52.Dv TIME_UTC .
53It returns time elapsed since epoch.
54.Sh RETURN VALUES
55The
56.Nm
57function returns the passed value of
58.Fa base
59if successful, otherwise
60.Dv 0
61on failure.
62.\" .Sh ERRORS
63.Sh SEE ALSO
64.Xr clock_gettime 2
65.Sh STANDARDS
66The
67.Nm
68function conforms to
69.St -isoC-2011 .
70.Sh HISTORY
71This interface first appeared in
72.Nx 8 .
73.Sh AUTHORS
74.An Kamil Rytarowski Aq Mt kamil@NetBSD.org
75