1/*
2 * Copyright (c) 2010 Apple Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * 1.  Redistributions of source code must retain the above copyright
11 *     notice, this list of conditions and the following disclaimer.
12 * 2.  Redistributions in binary form must reproduce the above copyright
13 *     notice, this list of conditions and the following disclaimer in the
14 *     documentation and/or other materials provided with the distribution.
15 * 3.  Neither the name of Apple Inc. ("Apple") nor the names of its
16 *     contributors may be used to endorse or promote products derived from
17 *     this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
20 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
23 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 *
30 * Portions of this software have been released under the following terms:
31 *
32 * (c) Copyright 1989-1993 OPEN SOFTWARE FOUNDATION, INC.
33 * (c) Copyright 1989-1993 HEWLETT-PACKARD COMPANY
34 * (c) Copyright 1989-1993 DIGITAL EQUIPMENT CORPORATION
35 *
36 * To anyone who acknowledges that this file is provided "AS IS"
37 * without any express or implied warranty:
38 * permission to use, copy, modify, and distribute this file for any
39 * purpose is hereby granted without fee, provided that the above
40 * copyright notices and this notice appears in all source code copies,
41 * and that none of the names of Open Software Foundation, Inc., Hewlett-
42 * Packard Company or Digital Equipment Corporation be used
43 * in advertising or publicity pertaining to distribution of the software
44 * without specific, written prior permission.  Neither Open Software
45 * Foundation, Inc., Hewlett-Packard Company nor Digital
46 * Equipment Corporation makes any representations about the suitability
47 * of this software for any purpose.
48 *
49 * Copyright (c) 2007, Novell, Inc. All rights reserved.
50 * Redistribution and use in source and binary forms, with or without
51 * modification, are permitted provided that the following conditions
52 * are met:
53 *
54 * 1.  Redistributions of source code must retain the above copyright
55 *     notice, this list of conditions and the following disclaimer.
56 * 2.  Redistributions in binary form must reproduce the above copyright
57 *     notice, this list of conditions and the following disclaimer in the
58 *     documentation and/or other materials provided with the distribution.
59 * 3.  Neither the name of Novell Inc. nor the names of its contributors
60 *     may be used to endorse or promote products derived from this
61 *     this software without specific prior written permission.
62 *
63 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
64 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
65 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
66 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY
67 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
68 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
69 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
70 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
71 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
72 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
73 *
74 * @APPLE_LICENSE_HEADER_END@
75 */
76
77/*
78**
79**  NAME:
80**
81**      uuid.idl
82**
83**  FACILITY:
84**
85**      UUID
86**
87**  ABSTRACT:
88**
89**      UUID Interface Definition
90**
91**
92*/
93
94[local] interface uuid
95{
96import  "dce/lbase.idl";
97/*************************************************************************/
98/*************************  Common definitions  **************************/
99/*************************************************************************/
100
101/*
102 * architectural version 1
103 */
104const long      uuid_c_version          = 1;
105const long      uuid_c_version_highest  = 2;
106
107/*
108 * A vector of UUIDs.
109 */
110typedef struct
111{
112    unsigned32              count;
113    uuid_p_t                uuid[1];
114} uuid_vector_t, *uuid_vector_p_t;
115
116/*************************************************************************/
117/****************************  Status Codes  *****************************/
118/*************************************************************************/
119
120/* moved to rpcsts.msf. See dce_error.c */
121
122const long      uuid_s_ok                   = error_status_ok;
123
124/*
125 * U U I D _ C R E A T E
126 *
127 * Create a new UUID.
128 */
129void uuid_create
130(
131    [out]   idl_uuid_t              *uuid,
132    [out]   unsigned32          *status
133);
134
135/*
136 * U U I D _ C R E A T E _ N I L
137 *
138 * Create a 'nil' uuid
139 */
140void uuid_create_nil
141(
142    [out]   idl_uuid_t              *uuid,
143    [out]   unsigned32          *status
144);
145
146/*
147 * U U I D _ T O _ S T R I N G
148 *
149 * Convert a UUID in (non-human) UUID format to STRING format
150 */
151void uuid_to_string
152(
153    [in]    uuid_p_t            uuid,
154    [out]   unsigned_char_p_t   *uuid_string,
155    [out]   unsigned32          *status
156);
157
158/*
159 * U U I D _  F R O M _ S T R I N G
160 *
161 * Convert a UUID in STRING format to a UUID in UUID format
162 */
163void uuid_from_string
164(
165    [in]    unsigned_char_p_t   uuid_string,
166    [out]   idl_uuid_t              *uuid,
167    [out]   unsigned32          *status
168);
169
170/*
171 * U U I D _ E Q U A L
172 *
173 * Compare two UUIDs
174 */
175boolean32 uuid_equal
176(
177    [in]    uuid_p_t            uuid1,
178    [in]    uuid_p_t            uuid2,
179    [out]   unsigned32          *status
180);
181
182/*
183 * U U I D _ I S _ N I L
184 *
185 * Return boolean true if uuid is 'nil'
186 */
187boolean32 uuid_is_nil
188(
189    [in]    uuid_p_t            uuid,
190    [out]   unsigned32          *status
191);
192
193/*
194 * U U I D _ C O M P A R E
195 *
196 * Compare two UUIDs "lexically"
197 */
198signed32 uuid_lexcompare
199(
200    [in]    uuid_p_t            uuid1,
201    [in]    uuid_p_t            uuid2,
202    [out]   unsigned32          *status
203);
204
205/*
206 * U U I D _ H A S H
207 *
208 * Create a hash value for a UUID
209 */
210unsigned16 uuid_hash
211(
212    [in]    uuid_p_t            uuid,
213    [out]   unsigned32          *status
214);
215
216}
217