blob: 31a59267a5623a10a072a1038f5a953bd432de5f [file] [log] [blame]
bigbiff7b4c7a62015-01-01 19:44:14 -05001.\" 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_PARSE 3 "May 2009" "util-linux" "Libuuid API"
33.SH NAME
34uuid_parse \- convert an input UUID string into binary representation
35.SH SYNOPSIS
36.nf
37.B #include <uuid.h>
38.sp
39.BI "int uuid_parse( char *" in ", uuid_t " uu );
40.fi
41.SH DESCRIPTION
42The
43.B uuid_parse
44function converts the UUID string given by
45.I in
46into the binary representation. The input UUID is a string of the form
471b4e28ba\-2fa1\-11d2\-883f\-b9a761bde3fb (in
48.BR printf (3)
49format "%08x\-%04x\-%04x\-%04x\-%012x", 36 bytes plus the trailing '\e0').
50.SH RETURN VALUE
51Upon successfully parsing the input string, 0 is returned, and the UUID is
52stored in the location pointed to by
53.IR uu ,
54otherwise \-1 is returned.
55.SH "CONFORMING TO"
56OSF DCE 1.1
57.SH AUTHOR
58Theodore Y.\& Ts'o
59.SH AVAILABILITY
60.B libuuid
61is part of the util-linux package since version 2.15.1 and is available from
62ftp://ftp.kernel.org/pub/linux/utils/util-linux/.
63.na
64.SH "SEE ALSO"
65.BR uuid (3),
66.BR uuid_clear (3),
67.BR uuid_compare (3),
68.BR uuid_copy (3),
69.BR uuid_generate (3),
70.BR uuid_is_null (3),
71.BR uuid_time (3),
72.BR uuid_unparse (3)
73.ad