lib/libc/uuid/uuid.3

   1 .\" Copyright (c) 2002 Marcel Moolenaar
   2 .\" Copyright (c) 2002 Hiten Mahesh Pandya
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  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 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  19 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  20 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  21 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  22 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd October 29, 2002
  29 .Dt UUID 3
  30 .Os
  31 .Sh NAME
  32 .Nm uuid_compare , uuid_create , uuid_create_nil , uuid_equal ,
  33 .Nm uuid_from_string , uuid_hash , uuid_is_nil , uuid_to_string
  34 .Nd DCE 1.1 compliant UUID functions
  35 .Sh LIBRARY
  36 .Lb libc
  37 .Sh SYNOPSIS
  38 .In uuid.h
  39 .Ft int32_t
  40 .Fn uuid_compare "uuid_t *uuid1" "uuid_t *uuid2" "uint32_t *status"
  41 .Ft void
  42 .Fn uuid_create "uuid_t *uuid" "uint32_t *status"
  43 .Ft void
  44 .Fn uuid_create_nil "uuid_t *uuid" "uint32_t *status"
  45 .Ft int32_t
  46 .Fn uuid_equal "uuid_t *uuid1" "uuid_t *uuid2" "uint32_t *status"
  47 .Ft void
  48 .Fn uuid_from_string "const char *str" "uuid_t *uuid" "uint32_t *status"
  49 .Ft uint16_t
  50 .Fn uuid_hash "uuid_t *uuid" "uint32_t *status"
  51 .Ft int32_t
  52 .Fn uuid_is_nil "uuid_t *uuid" "uint32_t *status"
  53 .Ft void
  54 .Fn uuid_to_string "uuid_t *uuid" "char **str" "uint32_t *status"
  55 .Sh DESCRIPTION
  56 The family of DCE 1.1 compliant UUID functions allow applications to operate
  57 on universally unique identifiers, or UUIDs.
  58 The
  59 .Fn uuid_create
  60 and
  61 .Fn uuid_create_nil
  62 functions create UUIDs.
  63 The
  64 .Fn uuid_compare ,
  65 .Fn uuid_equal
  66 and
  67 .Fn uuid_is_nil
  68 functions can be used to test UUIDs.
  69 To convert from the binary representation to the string representation or
  70 vice versa, use
  71 .Fn uuid_to_string
  72 or
  73 .Fn uuid_from_string
  74 respectively.
  75 A 16-bit hash value can be obtained by calling
  76 .Fn uuid_hash .
  77 .Sh RETURN VALUES
  78 The successful or unsuccessful completion of the function is returned in
  79 the
  80 .Fa status
  81 argument.
  82 Possible values are:
  83 .Pp
  84 .Bl -tag -width ".Dv uuid_s_invalid_string_uuid"
  85 .It Dv uuid_s_ok
  86 The function completed successfully.
  87 .It Dv uuid_s_bad_version
  88 The UUID does not have a known version.
  89 .It Dv uuid_s_invalid_string_uuid
  90 The string representation of an UUID is not valid.
  91 .It Dv uuid_s_no_memory
  92 The meaning of the code escaped the writers mind.
  93 .El
  94 .Sh SEE ALSO
  95 .Xr uuidgen 1 ,
  96 .Xr uuidgen 2
  97 .Sh STANDARDS
  98 The UUID functions conform to the DCE 1.1 RPC specification.
  99 .Sh BUGS
 100 This manpage can be improved.