| 1 | /** @file
|
|---|
| 2 | *
|
|---|
| 3 | * InnoTek Portable Runtime - Universal Unique Identifiers (UUID).
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2006 InnoTek Systemberatung GmbH
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 10 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 11 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 12 | * General Public License as published by the Free Software Foundation,
|
|---|
| 13 | * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
|
|---|
| 14 | * distribution. VirtualBox OSE is distributed in the hope that it will
|
|---|
| 15 | * be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 16 | *
|
|---|
| 17 | * If you received this file as part of a commercial VirtualBox
|
|---|
| 18 | * distribution, then only the terms of your commercial VirtualBox
|
|---|
| 19 | * license agreement apply instead of the previous paragraph.
|
|---|
| 20 | */
|
|---|
| 21 |
|
|---|
| 22 | #ifndef __iprt_uuid_h__
|
|---|
| 23 | #define __iprt_uuid_h__
|
|---|
| 24 |
|
|---|
| 25 | #include <iprt/cdefs.h>
|
|---|
| 26 | #include <iprt/types.h>
|
|---|
| 27 |
|
|---|
| 28 | #ifdef IN_RING0
|
|---|
| 29 | # error "There are no RTUuid APIs available Ring-0 Host Context!"
|
|---|
| 30 | #endif
|
|---|
| 31 |
|
|---|
| 32 | __BEGIN_DECLS
|
|---|
| 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 | * @returns iprt status code.
|
|---|
| 43 | * @param pUuid Where to store generated uuid.
|
|---|
| 44 | */
|
|---|
| 45 | RTR3DECL(int) RTUuidCreate(PRTUUID pUuid);
|
|---|
| 46 |
|
|---|
| 47 | /**
|
|---|
| 48 | * Makes null UUID value.
|
|---|
| 49 | *
|
|---|
| 50 | * @returns iprt status code.
|
|---|
| 51 | * @param pUuid Where to store generated null uuid.
|
|---|
| 52 | */
|
|---|
| 53 | RTR3DECL(int) RTUuidClear(PRTUUID pUuid);
|
|---|
| 54 |
|
|---|
| 55 | /**
|
|---|
| 56 | * Checks if UUID is null.
|
|---|
| 57 | *
|
|---|
| 58 | * @returns true if UUID is null.
|
|---|
| 59 | * @param pUuid uuid to check.
|
|---|
| 60 | */
|
|---|
| 61 | RTR3DECL(int) RTUuidIsNull(PCRTUUID pUuid);
|
|---|
| 62 |
|
|---|
| 63 | /**
|
|---|
| 64 | * Compares two UUID values.
|
|---|
| 65 | *
|
|---|
| 66 | * @returns 0 if eq, < 0 or > 0.
|
|---|
| 67 | * @param pUuid1 First value to compare.
|
|---|
| 68 | * @param pUuid2 Second value to compare.
|
|---|
| 69 | */
|
|---|
| 70 | RTR3DECL(int) RTUuidCompare(PCRTUUID pUuid1, PCRTUUID pUuid2);
|
|---|
| 71 |
|
|---|
| 72 | /**
|
|---|
| 73 | * Converts binary UUID to its string representation.
|
|---|
| 74 | *
|
|---|
| 75 | * @returns iprt status code.
|
|---|
| 76 | * @param pUuid Uuid to convert.
|
|---|
| 77 | * @param pszString Where to store result string.
|
|---|
| 78 | * @param cchString pszString buffer length, must be >= RTUUID_STR_LENGTH.
|
|---|
| 79 | */
|
|---|
| 80 | RTR3DECL(int) RTUuidToStr(PCRTUUID pUuid, char *pszString, unsigned cchString);
|
|---|
| 81 |
|
|---|
| 82 | /**
|
|---|
| 83 | * Converts UUID from its string representation to binary format.
|
|---|
| 84 | *
|
|---|
| 85 | * @returns iprt status code.
|
|---|
| 86 | * @param pUuid Where to store result Uuid.
|
|---|
| 87 | * @param pszString String with UUID text data.
|
|---|
| 88 | */
|
|---|
| 89 | RTR3DECL(int) RTUuidFromStr(PRTUUID pUuid, const char *pszString);
|
|---|
| 90 |
|
|---|
| 91 | /** @} */
|
|---|
| 92 |
|
|---|
| 93 | __END_DECLS
|
|---|
| 94 |
|
|---|
| 95 | #endif
|
|---|
| 96 |
|
|---|
