Page tree

The license could not be verified: License Certificate has expired!

This page is under construction and is subject to change.

For a description of the major new features that were introduced, please see New Features in HDF5 Release 1.12.

This page provides information on the changes that a maintenance developer needs to be aware of between successive releases of HDF5, such as:

  • New or changed features or tools
  • Syntax and behavioral changes in the existing application programming interface (the API)
  • Certain types of changes in configuration or build processes

Note that bug fixes and performance enhancements in the C library are automatically picked up by the C++, Fortran, and Java libraries.

The following information is included below.

The release notes also list changes made to the library, but these notes tend to be more at a more detail-oriented level. The release notes may include new features, bugs fixed, supported configuration features, platforms on which the library has been tested, and known problems. The release note files are listed below and can be found at the top level of the HDF5 source code tree in the release_docs directory.

Release Notes

Technical notes regarding the current release of the HDF5 library (RELEASE.txt in the source code)


Release information for all HDF5-1.10 releases


Development history between the HDF5-1.8.0 and HDF5-1.10.0 releases


Release information for HDF5-1.10.0 through 1.10.5.


Technical notes starting with HDF5-1.0.0 and ending with HDF5-1.8.0-rc3 (the state of the code prior to the HDF5-1.8.0 release)

Release 1.12.0 versus Release 1.10.5

This section lists interface-level changes and other user-visible changes in behavior in the transition from HDF5 Release 1.10.5 to Release 1.12.0.

New Features

For a description of the major new features that were introduced, please see New Features in HDF5 Release 1.12.

New and Changed Functions, Classes, Subroutines, Wrappers, and Macros

In the C/Fortran Interface (main library)

Folllowing are the new or changed APIs introduced in HDF5-1.12.0. Those introduced with a new feature list the specific new feature that they were added for.

Procedure / FunctionFortranDescription or Change
H5F_DELETE Deletes an HDF5 file
H5F_GET_FILENOYRetrieves a file's file number that uniquely identifies the open file
H5F_IS_ACCESSIBLEYDetermines if a file can be opened with a given fapl
H5O_GET_INFO, H5O_GET_INFO1 The function H5O_GET_INFO was replaced by the macro H5O_GET_INFO, and the function H5O_GET_INFO1 was deprecated.
H5O_GET_INFO_BY_IDX, H5O_GET_INFO_BY_IDX1 The function H5O_GET_INFO_BY_IDX was replaced by the macro H5O_GET_INFO_BY_IDX, and the function H5O_GET_INFO_BY_IDX1 was deprecated.
H5O_GET_INFO_BY_NAME, H5O_GET_INFO_BY_NAME1 The function H5O_GET_INFO_BY_NAME was replaced by the macro H5O_GET_INFO_BY_NAME, and the function H5O_GET_INFO_BY_NAME1 was deprecated.
H5O_VISIT, H5O_VISIT1 The function H5O_VISIT was replaced by the macro H5O_VISIT, and the function H5O_VISIT1 was deprecated.
H5O_VISIT_BY_NAME, H5O_VISIT_BY_NAME1 The function H5O_VISIT_BY_NAME was replaced by the macro H5O_VISIT_BY_NAME, and the function H5O_VISIT_BY_NAME1 was deprecated.



Encodes properties on a property list into a buffer

The previous function was renamed to H5P_ENCODE1 and deprecated, and the macro H5P_ENCODE was introduced.

H5P_GET_VOL_IDYReturns the identifier of the current VOL connector
H5P_GET_VOL_INFONReturns a copy of the VOL information for a connector
H5P_SET_VOLYSet the file VOL connector for a file access property list
H5P_SET_FAPL_HDFS Sets up Read-Only HDFS virtual file driver
H5P_SET_FAPL_ROS3 Sets up Read-Only S3 virtual file driver
H5R_COPY Copies an existing reference
H5R_CREATE_ATTR Creates an attribute reference
H5R_CREATE_OBJECT Creates an object reference
H5R_CREATE_REGION Creates a region reference
H5R_DESTROY Closes a reference
H5R_EQUAL Determines whether two references are equal
H5R_GET_ATTR_NAME Retrieves the attribute name for a referenced object
H5R_GET_FILE_NAME Retrieves the file name for a referenced object
H5R_GET_OBJ_NAME Retrieves the object name for a referenced object
H5R_GET_OBJ_TYPE3 Retrieves the type of object that an object reference points to
H5R_GET_TYPE Retrieves the type of reference
H5R_OPEN_ATTR Opens the referenced HDF5 attribute
H5R_OPEN_OBJECT Opens the referenced HDF5 object
H5R_OPEN_REGION Sets up a dataspace and selection as specified by a region reference
H5S_COMBINE_HYPERSLAB Performs an operation on a hyperslab and an existing selection and returns the resulting selection

Combines two hyperslab selections with an operation, returning a dataspace with the resulting selection



Encodes a dataspace object description into a binary buffer

The function H5S_ENCODE was renamed to H5S_ENCODE1 and deprecated in this release. The macro H5S_ENCODE and the function H5S_ENCODE2 were introduced in this release.

H5S_HYPER_ADJUST_S Adjusts a hyperslab selection by subtracting an offset

Refines a hyperslab selection with an operation using a second hyperslab to modify it


Closes a dataspace selection iterator

H5S_SEL_ITER_CREATE Creates a dataspace selection iterator for a dataspace's selection
H5S_SEL_ITER_GET_SEQ_LIST Retrieves a list of offset / length sequences for the elements in an iterator
H5S_SELECT_ADJUST_U  Adjusts a selection by subtracting an offset
H5S_SELECT_COPY Copies a selection from one dataspace to another
H5S_SELECT_INTERSECT_BLOCK Checks if current selection intersects with a block

Checks if two selections are the same shape

H5VL_CLOSEYCloses a VOL connector identifier
H5VL_GET_CONNECTOR_IDYRetrieves the identifier for a registered VOL connector
H5VL_GET_CONNECTOR_NAMEYRetrieves the connector name for the VOL associated with the object or file identifier
H5VL_IS_CONNECTOR_REGISTEREDYTests whether a VOL class has been registered or not
H5VL_REGISTER_CONNECTORNRegisters a new VOL connector
H5VL_REGISTER_CONNECTOR_BY_NAMEYRegisters a new VOL connector by name
H5VL_REGISTER_CONNECTOR_BY_VALUEYRegisters a new VOL connector by connector value
H5VL_UNREGISTER_CONNECTORYRemoves a VOL connector identifier from the library


In the C++ Wrapper

H5File::getFileNum ( )  


In the Fortran Wrapper

In the Java wrapper

New and Changed Elements of the Packet Table (H5PT) High-level API

In the C Interface


In the C++ Interface


In the Fortran Interface

In the Java Interface

Functions with Changed Behavior


API Compatibility

See API Compatibility Macros in HDF5 for details on the following.

New API Compatibility Flag

Compatibility Report and Comments

Compatibility report for Release 1.12.0 versus Release 1.10.5

   See API Compatibility Reports for information regarding compatibility with previous releases.


--- Last Modified: October 23, 2019 | 02:04 PM