Apache Portable Runtime
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
apr_env.h
Go to the documentation of this file.
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 #ifndef APR_ENV_H
18 #define APR_ENV_H
19 /**
20  * @file apr_env.h
21  * @brief APR Environment functions
22  */
23 #include "apr_errno.h"
24 #include "apr_pools.h"
25 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif /* __cplusplus */
29 
30 /**
31  * @defgroup apr_env Functions for manipulating the environment
32  * @ingroup APR
33  * @{
34  */
35 
36 /**
37  * Get the value of an environment variable
38  * @param value the returned value, allocated from @a pool
39  * @param envvar the name of the environment variable
40  * @param pool where to allocate @a value and any temporary storage from
41  */
42 APR_DECLARE(apr_status_t) apr_env_get(char **value, const char *envvar,
43  apr_pool_t *pool);
44 
45 /**
46  * Set the value of an environment variable
47  * @param envvar the name of the environment variable
48  * @param value the value to set
49  * @param pool where to allocate temporary storage from
50  */
51 APR_DECLARE(apr_status_t) apr_env_set(const char *envvar, const char *value,
52  apr_pool_t *pool);
53 
54 /**
55  * Delete a variable from the environment
56  * @param envvar the name of the environment variable
57  * @param pool where to allocate temporary storage from
58  */
59 APR_DECLARE(apr_status_t) apr_env_delete(const char *envvar, apr_pool_t *pool);
60 
61 /** @} */
62 
63 #ifdef __cplusplus
64 }
65 #endif
66 
67 #endif /* ! APR_ENV_H */