mirror of
https://github.com/HDFGroup/hdf5.git
synced 2025-01-30 15:32:37 +08:00
cf25524474
* Create a tag file for permalinks. * Added DOXYGEN_TAG_FILE. * Added Doxygen life-cycle examples for different modules. Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
83 lines
3.2 KiB
C
83 lines
3.2 KiB
C
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
* Copyright by The HDF Group. *
|
|
* All rights reserved. *
|
|
* *
|
|
* This file is part of HDF5. The full HDF5 copyright notice, including *
|
|
* terms governing use, modification, and redistribution, is contained in *
|
|
* the COPYING file, which can be found at the root of the source code *
|
|
* distribution tree, or in https://www.hdfgroup.org/licenses. *
|
|
* If you do not have access to either file, you may request a copy from *
|
|
* help@hdfgroup.org. *
|
|
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
|
|
|
/*
|
|
* Programmer: Quincey Koziol
|
|
* Saturday, September 12, 2015
|
|
*
|
|
* Purpose: This file contains declarations which define macros for the
|
|
* H5E package. Including this header means that the source file
|
|
* is part of the H5E package.
|
|
*/
|
|
#ifndef H5Emodule_H
|
|
#define H5Emodule_H
|
|
|
|
/* Define the proper control macros for the generic FUNC_ENTER/LEAVE and error
|
|
* reporting macros.
|
|
*/
|
|
#define H5E_MODULE
|
|
#define H5_MY_PKG H5E
|
|
#define H5_MY_PKG_ERR H5E_ERROR
|
|
#define H5_MY_PKG_INIT YES
|
|
|
|
/**\defgroup H5E H5E
|
|
*
|
|
* Use the functions in this module to manage HDF5 error stacks and error
|
|
* messages.
|
|
*
|
|
* <table>
|
|
* <tr><th>Create</th><th>Read</th></tr>
|
|
* <tr valign="top">
|
|
* <td>
|
|
* \snippet{lineno} H5E_examples.c create
|
|
* </td>
|
|
* <td>
|
|
* \snippet{lineno} H5E_examples.c read
|
|
* </td>
|
|
* <tr><th>Update</th><th>Delete</th></tr>
|
|
* <tr valign="top">
|
|
* <td>
|
|
* \snippet{lineno} H5E_examples.c update
|
|
* </td>
|
|
* <td>
|
|
* \snippet{lineno} H5E_examples.c delete
|
|
* </td>
|
|
* </tr>
|
|
* </table>
|
|
*
|
|
* \internal The \c FUNC_ENTER macro clears the error stack whenever an
|
|
* interface function is entered. When an error is detected, an entry
|
|
* is pushed onto the stack. As the functions unwind, additional
|
|
* entries are pushed onto the stack. The API function will return
|
|
* some indication that an error occurred and the application can
|
|
* print the error stack.
|
|
*
|
|
* \internal Certain API functions in the \ref H5E package, such as H5Eprint(),
|
|
* do not clear the error stack. Otherwise, any function which does
|
|
* not have an underscore immediately after the package name will
|
|
* clear the error stack. For instance, H5Fopen() clears the error
|
|
* stack while \Code{H5F_open} does not.
|
|
*
|
|
* \internal An error stack has a fixed maximum size. If this size is exceeded
|
|
* then the stack will be truncated and only the inner-most functions
|
|
* will have entries on the stack. This is expected to be a rare
|
|
* condition.
|
|
*
|
|
* \internal Each thread has its own error stack, but since multi-threading has
|
|
* not been added to the library yet, this package maintains a single
|
|
* error stack. The error stack is statically allocated to reduce the
|
|
* complexity of handling errors within the \ref H5E package.
|
|
*
|
|
*/
|
|
|
|
#endif /* H5Emodule_H */
|