shlibs/uuid/man/uuid_time.3

   1 .\" Copyright 1999 Andreas Dilger (adilger@enel.ucalgary.ca)
   2 .\"
   3 .\" %Begin-Header%
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, and the entire permission notice in its entirety,
   9 .\"    including the disclaimer of warranties.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. The name of the author may not be used to endorse or promote
  14 .\"    products derived from this software without specific prior
  15 .\"    written permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
  18 .\" WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ALL OF
  20 .\" WHICH ARE HEREBY DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE
  21 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  22 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
  23 .\" OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  24 .\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  25 .\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  27 .\" USE OF THIS SOFTWARE, EVEN IF NOT ADVISED OF THE POSSIBILITY OF SUCH
  28 .\" DAMAGE.
  29 .\" %End-Header%
  30 .\"
  31 .\" Created  Wed Mar 10 17:42:12 1999, Andreas Dilger
  32 .TH UUID_TIME 3 "May 2009" "util-linux-ng" "Libuuid API"
  33 .SH NAME
  34 uuid_time \- extract the time at which the UUID was created
  35 .SH SYNOPSIS
  36 .nf
  37 .B #include <uuid/uuid.h>
  38 .sp
  39 .BI "time_t uuid_time(uuid_t " uu ", struct timeval *" ret_tv )
  40 .fi
  41 .SH DESCRIPTION
  42 The
  43 .B uuid_time
  44 function extracts the time at which the supplied time-based UUID
  45 .I uu
  46 was created.  Note that the UUID creation time is only encoded within
  47 certain types of UUIDs.  This function can only reasonably expect to
  48 extract the creation time for UUIDs created with the
  49 .BR uuid_generate_time (3)
  50 function.  It may or may not work with UUIDs created by other mechanisms.
  51 .SH "RETURN VALUES"
  52 The time at which the UUID was created, in seconds since January 1, 1970 GMT
  53 (the epoch), is returned (see
  54 .BR time "(2))."
  55 The time at which the UUID was created, in seconds and microseconds since
  56 the epoch, is also stored in the location pointed to by
  57 .I ret_tv
  58 (see
  59 .BR gettimeofday "(2))."
  60 .SH AUTHOR
  61 Theodore Y. Ts'o
  62 .SH AVAILABILITY
  63 .B libuuid
  64 is part of the util-linux-ng package since version 2.15.1 and is available from
  65 ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/.
  66 .SH "SEE ALSO"
  67 .BR uuid (3),
  68 .BR uuid_clear (3),
  69 .BR uuid_compare (3),
  70 .BR uuid_copy (3),
  71 .BR uuid_generate (3),
  72 .BR uuid_is_null (3),
  73 .BR uuid_parse (3),
  74 .BR uuid_unparse (3)