home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F277243_apr_uuid.h < prev    next >
C/C++ Source or Header  |  2004-02-13  |  2KB  |  76 lines
  1. /* Copyright 2000-2004 The Apache Software Foundation
  2.  *
  3.  * Licensed under the Apache License, Version 2.0 (the "License");
  4.  * you may not use this file except in compliance with the License.
  5.  * You may obtain a copy of the License at
  6.  *
  7.  *     http://www.apache.org/licenses/LICENSE-2.0
  8.  *
  9.  * Unless required by applicable law or agreed to in writing, software
  10.  * distributed under the License is distributed on an "AS IS" BASIS,
  11.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12.  * See the License for the specific language governing permissions and
  13.  * limitations under the License.
  14.  */
  15.  
  16. /**
  17.  * @file apr_uuid.h
  18.  * @brief APR UUID library
  19.  */
  20. #ifndef APR_UUID_H
  21. #define APR_UUID_H
  22.  
  23. #include "apu.h"
  24. #include "apr_errno.h"
  25.  
  26. #ifdef __cplusplus
  27. extern "C" {
  28. #endif /* __cplusplus */
  29.  
  30. /**
  31.  * @defgroup APR_UUID UUID Handling
  32.  * @ingroup APR
  33.  * @{
  34.  */
  35.  
  36. /**
  37.  * we represent a UUID as a block of 16 bytes.
  38.  */
  39.  
  40. typedef struct {
  41.     unsigned char data[16]; /**< the actual UUID */
  42. } apr_uuid_t;
  43.  
  44. /** UUIDs are formatted as: 00112233-4455-6677-8899-AABBCCDDEEFF */
  45. #define APR_UUID_FORMATTED_LENGTH 36
  46.  
  47.  
  48. /**
  49.  * Generate and return a (new) UUID
  50.  * @param uuid The resulting UUID
  51.  */ 
  52. APU_DECLARE(void) apr_uuid_get(apr_uuid_t *uuid);
  53.  
  54. /**
  55.  * Format a UUID into a string, following the standard format
  56.  * @param buffer The buffer to place the formatted UUID string into. It must
  57.  *               be at least APR_UUID_FORMATTED_LENGTH + 1 bytes long to hold
  58.  *               the formatted UUID and a null terminator
  59.  * @param uuid The UUID to format
  60.  */ 
  61. APU_DECLARE(void) apr_uuid_format(char *buffer, const apr_uuid_t *uuid);
  62.  
  63. /**
  64.  * Parse a standard-format string into a UUID
  65.  * @param uuid The resulting UUID
  66.  * @param uuid_str The formatted UUID
  67.  */ 
  68. APU_DECLARE(apr_status_t) apr_uuid_parse(apr_uuid_t *uuid, const char *uuid_str);
  69.  
  70. /** @} */
  71. #ifdef __cplusplus
  72. }
  73. #endif
  74.  
  75. #endif /* APR_UUID_H */
  76.