]> git.ipfire.org Git - thirdparty/util-linux.git/blob - libuuid/man/uuid_is_null.3
fea469e466ed43e83f585300007d71de4eb76ca1
[thirdparty/util-linux.git] / libuuid / man / uuid_is_null.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_IS_NULL 3 "May 2009" "util-linux" "Libuuid API"
33 .SH NAME
34 uuid_is_null \- compare the value of the UUID to the NULL value
35 .SH SYNOPSIS
36 .nf
37 .B #include <uuid.h>
38 .sp
39 .BI "int uuid_is_null(uuid_t " uu );
40 .fi
41 .SH DESCRIPTION
42 The
43 .B uuid_is_null
44 function compares the value of the supplied UUID variable
45 .I uu
46 to the NULL value. If the value is equal to the NULL UUID, 1 is returned,
47 otherwise 0 is returned.
48 .SH AUTHOR
49 Theodore Y.\& Ts'o
50 .SH AVAILABILITY
51 .B libuuid
52 is part of the util-linux package since version 2.15.1 and is available from
53 https://www.kernel.org/pub/linux/utils/util-linux/.
54 .na
55 .SH SEE ALSO
56 .BR uuid (3),
57 .BR uuid_clear (3),
58 .BR uuid_compare (3),
59 .BR uuid_copy (3),
60 .BR uuid_generate (3),
61 .BR uuid_time (3),
62 .BR uuid_parse (3),
63 .BR uuid_unparse (3)
64 .ad