pub.mod/libuuid.mod/libuuid/man/uuid_time.3

.\" Copyright 1999 Andreas Dilger ([email protected])
.\"
.\" %Begin-Header%
.\" 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, and the entire permission notice in its entirety,
.\"    including the disclaimer of warranties.
.\" 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. The name of the author may not be used to endorse or promote
.\"    products derived from this software without specific prior
.\"    written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
.\" WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ALL OF
.\" WHICH ARE HEREBY DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR 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 NOT ADVISED OF THE POSSIBILITY OF SUCH
.\" DAMAGE.
.\" %End-Header%
.\"
.\" Created  Wed Mar 10 17:42:12 1999, Andreas Dilger
.TH UUID_TIME 3 "May 2009" "util-linux" "Libuuid API"
.SH NAME
uuid_time \- extract the time at which the UUID was created
.SH SYNOPSIS
.nf
.B #include <uuid.h>
.sp
.BI "time_t uuid_time(uuid_t " uu ", struct timeval *" ret_tv )
.fi
.SH DESCRIPTION
The
.B uuid_time
function extracts the time at which the supplied time-based UUID
.I uu
was created.  Note that the UUID creation time is only encoded within
certain types of UUIDs.  This function can only reasonably expect to
extract the creation time for UUIDs created with the
.BR uuid_generate_time (3)
and
.BR uuid_generate_time_safe (3)
functions.  It may or may not work with UUIDs created by other mechanisms.
.SH "RETURN VALUES"
The time at which the UUID was created, in seconds since January 1, 1970 GMT
(the epoch), is returned (see
.BR time "(2))."
The time at which the UUID was created, in seconds and microseconds since
the epoch, is also stored in the location pointed to by
.I ret_tv
(see
.BR gettimeofday "(2))."
.SH AUTHOR
Theodore Y.\& Ts'o
.SH AVAILABILITY
.B libuuid
is part of the util-linux package since version 2.15.1 and is available from
https://www.kernel.org/pub/linux/utils/util-linux/.
.na
.SH "SEE ALSO"
.BR uuid (3),
.BR uuid_clear (3),
.BR uuid_compare (3),
.BR uuid_copy (3),
.BR uuid_generate (3),
.BR uuid_is_null (3),
.BR uuid_parse (3),
.BR uuid_unparse (3)
.ad