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 / F277200_apr_env.h < prev    next >
C/C++ Source or Header  |  2004-02-13  |  2KB  |  67 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. #ifndef APR_ENV_H
  17. #define APR_ENV_H
  18. /**
  19.  * @file apr_env.h
  20.  * @brief APR Environment functions
  21.  */
  22. #include "apr_errno.h"
  23. #include "apr_pools.h"
  24.  
  25. #ifdef __cplusplus
  26. extern "C" {
  27. #endif /* __cplusplus */
  28.  
  29. /**
  30.  * @defgroup apr_env Functions for manupulating the environment
  31.  * @ingroup APR 
  32.  * @{
  33.  */
  34.  
  35. /**
  36.  * Get the value of an environment variable
  37.  * @param value the returned value, allocated from @a pool
  38.  * @param envvar the name of the environment variable
  39.  * @param pool where to allocate @a value and any temporary storage from
  40.  */
  41. APR_DECLARE(apr_status_t) apr_env_get(char **value, const char *envvar,
  42.                                       apr_pool_t *pool);
  43.  
  44. /**
  45.  * Set the value of an environment variable
  46.  * @param envvar the name of the environment variable
  47.  * @param value the value to set
  48.  * @param pool where to allocate temporary storage from
  49.  */
  50. APR_DECLARE(apr_status_t) apr_env_set(const char *envvar, const char *value,
  51.                                       apr_pool_t *pool);
  52.  
  53. /**
  54.  * Delete a variable from the environment
  55.  * @param envvar the name of the environment variable
  56.  * @param pool where to allocate temporary storage from
  57.  */
  58. APR_DECLARE(apr_status_t) apr_env_delete(const char *envvar, apr_pool_t *pool);
  59.  
  60. /** @} */
  61.  
  62. #ifdef __cplusplus
  63. }
  64. #endif
  65.  
  66. #endif  /* ! APR_ENV_H */
  67.