Main Page | Modules | Data Structures | File List | Data Fields | Globals | Related Pages

apr_inherit.h

Go to the documentation of this file.
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_INHERIT_H
00017 #define APR_INHERIT_H
00018 
00019 /**
00020  * @file apr_inherit.h 
00021  * @brief APR File Handle Inheritance Helpers
00022  * @remark This internal header includes internal declaration helpers 
00023  * for other headers to declare apr_foo_inherit_[un]set functions.
00024  */
00025 
00026 /**
00027  * Prototype for type-specific declarations of apr_foo_inherit_set 
00028  * functions.  
00029  * @remark Doxygen unwraps this macro (via doxygen.conf) to provide 
00030  * actual help for each specific occurance of apr_foo_inherit_set.
00031  * @remark the linkage is specified for APR. It would be possible to expand
00032  *       the macros to support other linkages.
00033  */
00034 #define APR_DECLARE_INHERIT_SET(type) \
00035     APR_DECLARE(apr_status_t) apr_##type##_inherit_set( \
00036                                           apr_##type##_t *the##type)
00037 
00038 /**
00039  * Prototype for type-specific declarations of apr_foo_inherit_unset 
00040  * functions.  
00041  * @remark Doxygen unwraps this macro (via doxygen.conf) to provide 
00042  * actual help for each specific occurance of apr_foo_inherit_unset.
00043  * @remark the linkage is specified for APR. It would be possible to expand
00044  *       the macros to support other linkages.
00045  */
00046 #define APR_DECLARE_INHERIT_UNSET(type) \
00047     APR_DECLARE(apr_status_t) apr_##type##_inherit_unset( \
00048                                           apr_##type##_t *the##type)
00049 
00050 #endif  /* ! APR_INHERIT_H */

Generated on Sat Apr 2 21:46:29 2005 for Apache Portable Runtime by  doxygen 1.3.9.1