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