github.com/krum110487/go-htaccess@v0.0.0-20240316004156-60641c8e7598/tests/data/apache_2_2_34/include/apr_uuid.h (about)

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