API Documentation for HDF5 Version 1.13 (Draft)

Todo:

Fix the search form for server deployments.

Make it mobile-friendly

Introduction

Todo:

Write an introduction.

Quick Links

• Predefined Datatypes
• API Compatibility Macros
• HDF5 Wiki

The Use of Locations (Identifier + Name) in the HDF5 API

Todo:

Make this crystal clear!

Programming Note for C++ Developers Using C Functions

If a C routine that takes a function pointer as an argument is called from within C++ code, the C routine should be returned from normally.

Examples of this kind of routine include callbacks such as H5Pset_elink_cb() and H5Pset_type_conv_cb() and functions such as H5Tconvert() and H5Ewalk2().

Exiting the routine in its normal fashion allows the HDF5 C library to clean up its work properly. In other words, if the C++ application jumps out of the routine back to the C++ catch statement, the library is not given the opportunity to close any temporary data structures that were set up when the routine was called. The C++ application should save some state as the routine is started so that any problem that occurs might be diagnosed.