00001 /* Copyright 2000-2004 The Apache Software Foundation 00002 * 00003 * Licensed under the Apache License, Version 2.0 (the "License"); 00004 * you may not use this file except in compliance with the License. 00005 * You may obtain a copy of the License at 00006 * 00007 * http://www.apache.org/licenses/LICENSE-2.0 00008 * 00009 * Unless required by applicable law or agreed to in writing, software 00010 * distributed under the License is distributed on an "AS IS" BASIS, 00011 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 00012 * See the License for the specific language governing permissions and 00013 * limitations under the License. 00014 */ 00015 00016 #ifndef APR_ENV_H 00017 #define APR_ENV_H 00018 /** 00019 * @file apr_env.h 00020 * @brief APR Environment functions 00021 */ 00022 #include "apr_errno.h" 00023 #include "apr_pools.h" 00024 00025 #ifdef __cplusplus 00026 extern "C" { 00027 #endif /* __cplusplus */ 00028 00029 /** 00030 * @defgroup apr_env Functions for manupulating the environment 00031 * @ingroup APR 00032 * @{ 00033 */ 00034 00035 /** 00036 * Get the value of an environment variable 00037 * @param value the returned value, allocated from @a pool 00038 * @param envvar the name of the environment variable 00039 * @param pool where to allocate @a value and any temporary storage from 00040 */ 00041 APR_DECLARE(apr_status_t) apr_env_get(char **value, const char *envvar, 00042 apr_pool_t *pool); 00043 00044 /** 00045 * Set the value of an environment variable 00046 * @param envvar the name of the environment variable 00047 * @param value the value to set 00048 * @param pool where to allocate temporary storage from 00049 */ 00050 APR_DECLARE(apr_status_t) apr_env_set(const char *envvar, const char *value, 00051 apr_pool_t *pool); 00052 00053 /** 00054 * Delete a variable from the environment 00055 * @param envvar the name of the environment variable 00056 * @param pool where to allocate temporary storage from 00057 */ 00058 APR_DECLARE(apr_status_t) apr_env_delete(const char *envvar, apr_pool_t *pool); 00059 00060 /** @} */ 00061 00062 #ifdef __cplusplus 00063 } 00064 #endif 00065 00066 #endif /* ! APR_ENV_H */