]> git.saurik.com Git - apple/libc.git/blame - uuid/uuid_unparse.3-uuid.in
Libc-498.1.5.tar.gz
[apple/libc.git] / uuid / uuid_unparse.3-uuid.in
CommitLineData
224c7076
A
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_UNPARSE 3 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "@E2FSPROGS_VERSION@"
33.SH NAME
34uuid_unparse \- convert an UUID from binary representation to a string
35.SH SYNOPSIS
36.nf
37.B #include <uuid/uuid.h>
38.sp
39\fIvoid\fP
40.br
41\fBuuid_unparse\fP(\fIuuid_t uu\fP, \fIchar * out\fP);
42.sp
43\fIvoid\fP
44.br
45\fBuuid_unparse_lower\fP(\fIuuid_t uu\fP, \fIchar * out\fP);
46.sp
47\fIvoid\fP
48.br
49\fBuuid_unparse_upper\fP(\fIuuid_t uu\fP, \fIchar * out\fP);
50.sp
51.fi
52.SH DESCRIPTION
53The
54.B uuid_unparse
55function converts the supplied UUID
56.I uu
57from the binary representation into a 36\-byte string (plus tailing '\\0')
58of the form 1b4e28ba\-2fa1\-11d2\-883f\-b9a76 and stores this value in the
59character string pointed to by
60.IR out .
61The case of the hex digits returned by
62.B uuid_unparse
63may be upper or lower case, and is
64dependent on the system-dependent local default.
65.PP
66If the case of the
67hex digits is important then the functions
68.B uuid_unparse_upper
69and
70.B uuid_unparse_lower
71may be used.
72.SH "CONFORMING TO"
73OSF DCE 1.1
74.SH AUTHOR
75Theodore Y. Ts'o
76.SH AVAILABILITY
77.UR http://e2fsprogs.sourceforge.net/
78http://e2fsprogs.sourceforge.net/
79.UE
80.SH "SEE ALSO"
81.BR uuid (3),
82.BR uuid_clear (3),
83.BR uuid_compare (3),
84.BR uuid_copy (3),
85.BR uuid_generate (3),
86.BR uuid_is_null (3),
87.BR uuid_parse (3)