.\"
.\" Copyright (c) 2016 The DragonFly Project. All rights reserved.
.\"
.\" This code is derived from software contributed to The DragonFly Project
.\" by Tomasz Konojacki <me@xenu.pl>.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in
.\"    the documentation and/or other materials provided with the
.\"    distribution.
.\" 3. Neither the name of The DragonFly Project nor the names of its
.\"    contributors may be used to endorse or promote products derived
.\"    from this software without specific, prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd January 30, 2016
.Dt TIMESPEC_GET 3
.Os
.Sh NAME
.Nm timespec_get
.Nd Set specified timespec structure to a current time
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In time.h
.Ft int
.Fn timespec_get "struct timespec *ts" "int base"
.Sh DESCRIPTION
The function
.Fn timespec_get
takes two arguments, a pointer to a
.Vt timespec
structure and desired time base.
The function sets structure pointed by the
.Fa ts
argument to hold current clock time, basing on time base specified in the
.Fa base
argument.
Currently only the
.Dv TIME_UTC
base is supported.
.Sh RETURN VALUES
Upon successful completion,
.Fn timespec_get
will use its argument
.Fa base
as a return value.
Otherwise, a value of 0 is returned and
.Va errno
is set to indicate the error.
.Sh ERRORS
.Bl -tag -width Er
.It Bq Er EINVAL
The
.Fa base
argument to
.Fn timespec_get
was invalid.
.El
.Pp
The
.Fn timespec_get
function may also fail and set
.Va errno
for any of the errors specified for
.Xr clock_gettime 2 .
.Sh SEE ALSO
.Xr clock_gettime 2 ,
.Xr time 3
.Sh STANDARDS
The
.Fn timespec_get
function conforms to
.St -isoC-2011 .