65393a863e
functions is expected for uuidgen(1), mca(8) and gpt(8). Given the generic use of UUIDs beyond the scope of the DCE 1.1 specification, visibility of the data structure at all levels of the machine, including firmware and the wish to not create a permanent build- time FreeBSD-ism for DCE compliant applications by creating a new library, it was decided that libc would be the least inappropriate place. Also, because the UUID functions live in libc under IRIX as well, we have maximized our portability and left as many options open as possible. This implementation introduces an extension not found in the specification: the status parameter is allowed to be a NULL- pointer. The reason for introducing the extension is because the status is almost never of any use. The manpage that's part of this commit is a minimal place-holder and is further fleshed-out in the near future. Approved by: re@ Contributed by: Hiten Mahesh Pandya <hiten@unixdaemons.com> Sponsored by: marcel :-) Tested on: alpha, i386, ia64
99 lines
3.3 KiB
Groff
99 lines
3.3 KiB
Groff
.\" Copyright (c) 2002 Marcel Moolenaar
|
|
.\" Copyright (c) 2002 Hiten Mahesh Pandya
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" 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.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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 ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.Dd October 29, 2002
|
|
.Dt UUID 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm uuid_compare , uuid_create , uuid_create_nil , uuid_equal ,
|
|
.Nm uuid_from_string , uuid_hash , uuid_is_nil , uuid_to_string
|
|
.Nd DCE 1.1 compliant UUID functions
|
|
.Sh LIBRARY
|
|
.Lb libc
|
|
.Sh SYNOPSIS
|
|
.In uuid.h
|
|
.Ft int32_t
|
|
.Fn uuid_compare "uuid_t *uuid1" "uuid_t *uuid2" "uint32_t *status"
|
|
.Ft void
|
|
.Fn uuid_create "uuid_t *uuid" "uint32_t *status"
|
|
.Ft void
|
|
.Fn uuid_create_nil "uuid_t *uuid" "uint32_t *status"
|
|
.Ft int32_t
|
|
.Fn uuid_equal "uuid_t *uuid1" "uuid_t *uuid2" "uint32_t *status"
|
|
.Ft void
|
|
.Fn uuid_from_string "const char *str" "uuid_t *uuid" "uint32_t *status"
|
|
.Ft uint16_t
|
|
.Fn uuid_hash "uuid_t *uuid" "uint32_t *status"
|
|
.Ft int32_t
|
|
.Fn uuid_is_nil "uuid_t *uuid" "uint32_t *status"
|
|
.Ft void
|
|
.Fn uuid_to_string "uuid_t *uuid" "char **str" "uint32_t *status"
|
|
.Sh DESCRIPTION
|
|
The family of DCE 1.1 compliant UUID functions allow applications to operate
|
|
on universally unique identifiers, or UUIDs.
|
|
The
|
|
.Fn uuid_create
|
|
and
|
|
.Fn uuid_create_nil
|
|
functions create UUIDs.
|
|
The
|
|
.Fn uuid_compare , uuid_equal
|
|
and
|
|
.Fn uuid_is_nil
|
|
functions can be used to test UUIDs.
|
|
To convert from the binary representation to the string representation or
|
|
vice versa, use
|
|
.Fn uuid_to_string
|
|
or
|
|
.Fn uuid_from_string
|
|
respectively.
|
|
A 16-bit hash value can be obtained by calling
|
|
.Fn uuid_hash .
|
|
.Sh RETURN VALUES
|
|
The successful or unsuccessful completion of the function is returned in
|
|
the
|
|
.Fa status
|
|
parameter. Possible values are:
|
|
.Pp
|
|
.Bl -tag -width uuid_s_invalid_string_uuid
|
|
.It Dv uuid_s_ok
|
|
The function completed successfully.
|
|
.It Dv uuid_s_bad_version
|
|
The UUID does not have a known version.
|
|
.It Dv uuid_s_invalid_string_uuid
|
|
The string representation of an UUID is not valid.
|
|
.It Dv uuid_s_no_memory
|
|
The meaning of the code escaped the writers mind.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr uuidgen 1 ,
|
|
.Xr uuidgen 2
|
|
.Sh BUGS
|
|
This manpage can be improved.
|
|
.Sh STANDARDS
|
|
The UUID functions conform to the DCE 1.1 RPC specification.
|