VirtualBox

source: vbox/trunk/include/iprt/uuid.h@ 66083

Last change on this file since 66083 was 62473, checked in by vboxsync, 8 years ago

(C) 2016

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 6.4 KB
Line 
1/** @file
2 * IPRT - Universal Unique Identifiers (UUID).
3 */
4
5/*
6 * Copyright (C) 2006-2016 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 */
25
26#ifndef ___iprt_uuid_h
27#define ___iprt_uuid_h
28
29#include <iprt/cdefs.h>
30#include <iprt/types.h>
31
32RT_C_DECLS_BEGIN
33
34/** @defgroup grp_rt_uuid RTUuid - Universally Unique Identifiers
35 * @ingroup grp_rt
36 * @{
37 */
38
39/**
40 * Generates new UUID value.
41 *
42 * @note IPRT uses little endian byte ordering in the UUID integer fields. If
43 * you want to pass IPRT UUIDs in binary representation to other UUID libraries
44 * and expect to get exactly the same string representation as in IPRT, you
45 * need to convert the first three integer fields (one 32 bit value, two 16 bit
46 * values) separately to big endian (also called network byte order).
47 *
48 * @sa RTUUID::Gen
49 *
50 * @returns iprt status code.
51 * @param pUuid Where to store generated uuid.
52 */
53RTDECL(int) RTUuidCreate(PRTUUID pUuid);
54
55/**
56 * Makes null UUID value.
57 *
58 * @returns iprt status code.
59 * @param pUuid Where to store generated null uuid.
60 */
61RTDECL(int) RTUuidClear(PRTUUID pUuid);
62
63/**
64 * Checks if UUID is null.
65 *
66 * @returns true if UUID is null.
67 * @param pUuid uuid to check.
68 */
69RTDECL(bool) RTUuidIsNull(PCRTUUID pUuid);
70
71/**
72 * Compares two UUID values.
73 *
74 * @returns 0 if eq, < 0 or > 0.
75 * @param pUuid1 First value to compare. NULL is treated like if
76 * RTUuidIsNull() return true.
77 * @param pUuid2 Second value to compare. NULL is treated like if
78 * RTUuidIsNull() return true.
79 */
80RTDECL(int) RTUuidCompare(PCRTUUID pUuid1, PCRTUUID pUuid2);
81
82/**
83 * Compares a UUID value with a UUID string.
84 *
85 * @note IPRT uses little endian byte ordering in the UUID integer fields. If
86 * you want to pass IPRT UUIDs in binary representation to other UUID libraries
87 * and expect to get exactly the same string representation as in IPRT, you need
88 * to convert the first three integer fields (one 32 bit value, two 16 bit
89 * values) separately to big endian (also called network byte order).
90 * Correspondingly, if you want to get the right result with UUIDs which are in
91 * big endian format, you need to convert them before using this function.
92 *
93 * @sa RTUUID::Gen
94 *
95 * @returns 0 if eq, < 0 or > 0.
96 * @param pUuid1 First value to compare. NULL is not allowed.
97 * @param pszString2 The 2nd UUID in string form. NULL or malformed
98 * string is not permitted.
99 */
100RTDECL(int) RTUuidCompareStr(PCRTUUID pUuid1, const char *pszString2);
101
102/**
103 * Compares two UUID strings.
104 *
105 * @returns 0 if eq, < 0 or > 0.
106 * @param pszString1 The 1st UUID in string from. NULL or malformed
107 * string is not permitted.
108 * @param pszString2 The 2nd UUID in string form. NULL or malformed
109 * string is not permitted.
110 */
111RTDECL(int) RTUuidCompare2Strs(const char *pszString1, const char *pszString2);
112
113/**
114 * Converts binary UUID to its string representation.
115 *
116 * @note IPRT uses little endian byte ordering in the UUID integer fields. If
117 * you want to pass IPRT UUIDs in binary representation to other UUID libraries
118 * and expect to get exactly the same string representation as in IPRT, you
119 * need to convert the first three integer fields (one 32 bit value, two 16 bit
120 * values) separately to big endian (also called network byte order).
121 * Correspondingly, if you want to get the right result with UUIDs which are in
122 * big endian format, you need to convert them before using this function.
123 *
124 * @sa RTUUID::Gen
125 *
126 * @returns iprt status code.
127 * @param pUuid Uuid to convert.
128 * @param pszString Where to store result string.
129 * @param cchString pszString buffer length, must be >= RTUUID_STR_LENGTH.
130 */
131RTDECL(int) RTUuidToStr(PCRTUUID pUuid, char *pszString, size_t cchString);
132
133/**
134 * Converts UUID from its string representation to binary format.
135 *
136 * @note IPRT uses little endian byte ordering in the UUID integer fields. If
137 * you want to pass IPRT UUIDs in binary representation to other UUID libraries
138 * and expect to get exactly the same string representation as in IPRT, you
139 * need to convert the first three integer fields (one 32 bit value, two 16 bit
140 * values) separately to big endian (also called network byte order).
141 * Correspondingly, if you want to get the right result with UUIDs which are in
142 * big endian format, you need to convert them before using this function.
143 *
144 * @sa RTUUID::Gen
145 *
146 * @returns iprt status code.
147 * @param pUuid Where to store result Uuid.
148 * @param pszString String with UUID text data.
149 */
150RTDECL(int) RTUuidFromStr(PRTUUID pUuid, const char *pszString);
151
152/**
153 * Converts binary UUID to its UTF-16 string representation.
154 *
155 * @note See note in RTUuidToStr.
156 *
157 * @sa RTUUID::Gen
158 *
159 * @returns iprt status code.
160 * @param pUuid Uuid to convert.
161 * @param pwszString Where to store result string.
162 * @param cwcString pszString buffer length, must be >=
163 * RTUUID_STR_LENGTH.
164 */
165RTDECL(int) RTUuidToUtf16(PCRTUUID pUuid, PRTUTF16 pwszString, size_t cwcString);
166
167/**
168 * Converts UUID from its UTF-16 string representation to binary format.
169 *
170 * @note See note in RTUuidFromStr.
171 *
172 * @sa RTUUID::Gen
173 *
174 * @returns iprt status code.
175 * @param pUuid Where to store result Uuid.
176 * @param pwszString String with UUID text data.
177 */
178RTDECL(int) RTUuidFromUtf16(PRTUUID pUuid, PCRTUTF16 pwszString);
179
180/** @} */
181
182RT_C_DECLS_END
183
184#endif
185
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette