HDF5 documents and links 
Introduction to HDF5 
HDF5 User's Guide 
HDF5 Reference Manual 
HDF5 Application Developer's Guide 

HDF5 Software Changes from Release to Release

This document is provided to assist application developers who must keep an application synchronized with the HDF5 Library or related software.

Release 1.8.12 of November 2013 (current release) versus Release 1.8.11

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

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

In the C Interface (main library)
The following C functions have been modified:
  • H5Zunregister now checks for open objects using a filter before allowing the filter to be unregistered.
  • H5Dscatter and H5Dgather signatures have changed slightly.
    The src_buff parameter type is now 'const void *'  (previously: 'void *').

In the C++ Interface
The following new C++ class has been added:
H5::H5Location
The class H5::H5Location has been added as a base class of H5File and H5Object. It represents the location concept in the C library, where an identifier of an HDF5 object or an HDF5 file being passed in as a loc_id parameter.

The following member functions and their overloaded versions have been moved from various subclasses into the base class H5Location:
createAttribute()
openAttribute()
attrExists()
renameAttr()
removeAttr()
flush()
getFileName()
getNumAttrs()
         getObjType()
iterateAttrs()
setComment()
getComment()
removeComment()
reference()
dereference()
getRegion()

The following wrappers for C functions have been added:
H5Location::getRefObjType
Corresponding C function: H5Rget_obj_type2
Retrieves the type of the object that an object reference points to.
H5Location::attrExists
Corresponding C function: H5Aexist
Determines whether a given attribute exists.
H5Location::setComment
Two overloaded versions of H5Location::setComment have been added to take "." in lieue of the name of the object.

In the classes DataSet, DataType, and Group, the following constructors have changed as follows:
  • These constructors
        DataSet(H5Object& obj, const void* ref, H5R_type_t ref_type = H5R_OBJECT);
        DataSet(H5File& h5file, const void* ref, H5R_type_t ref_type = H5R_OBJECT);
        DataSet(Attribute& attr, const void* ref, H5R_type_t ref_type = H5R_OBJECT);

    have changed to
        DataSet(const H5Location& loc, const void* ref, H5R_type_t ref_type = H5R_OBJECT);
        DataSet(const Attribute& attr, const void* ref, H5R_type_t ref_type = H5R_OBJECT);

  • These constructors
        DataType(H5Object& obj, const void* ref, H5R_type_t ref_type = H5R_OBJECT);
        DataType(H5File& h5file, const void* ref, H5R_type_t ref_type = H5R_OBJECT);
        DataType(Attribute& attr, const void* ref, H5R_type_t ref_type = H5R_OBJECT);

    have changed to
        DataType(const H5Location& loc, const void* ref, H5R_type_t ref_type = H5R_OBJECT);
        DataType(const Attribute& attr, const void* ref, H5R_type_t ref_type = H5R_OBJECT);

                                                                                            
  • These constructors
        Group(H5Object& obj, const void* ref, H5R_type_t ref_type = H5R_OBJECT);
        Group(H5File& h5file, const void* ref, H5R_type_t ref_type = H5R_OBJECT);
        Group(Attribute& attr, const void* ref, H5R_type_t ref_type = H5R_OBJECT);

    have changed to
        Group(const H5Location& loc, const void* ref, H5R_type_t ref_type = H5R_OBJECT);
        Group(const Attribute& attr, const void* ref, H5R_type_t ref_type = H5R_OBJECT);
  • New Command-line Tool Options and Option Parameters

    h5dump
    h5dump has a new option for identifying objects by a full or partial path:
       -NP
       --any-path=P
     
    The h5dump attributes-only option, -A or --only-attr, now accepts an optional parameter value of 0 (zero):
       -A 0
       --only-attr=0
    Specifying this value has the effect of reversing the role of the option to display everything except attributes.
     
    h5repack
    The h5repack option -f, --filter has a new parameter, UD, to enable the use of user-defined filters:
       -f UD=<filter_parameters>
       --filter=UD=<filter_parameters>
     
    h5stat
    h5stat has three new options for setting print thresholds:
       For attributes:
          -aN
          --attribute=N
     
       For links in a group:
          -lN
          --links=N
     
       For dimension sizes:
          -mN
          --dims=N

    Build and Configuration

    CMake and Autotools configuration
    A new configuration option can be used to change the default plugin path:
        Autotools configure option      --with-default-plugindir=location
      cmake option      -DH5_DEFAULT_PLUGINDIR:PATH=location

    CMake configuration
    CMake builds of HDF5 now create *.so.{lt_version} files with the same version as configure.

    Autotools configure flag
    The configure flag FFLAGS has been renamed to FCFLAGS.

    Compile Scripts with Changed Behavior

    h5cc and h5pcc
    h5c++
    h5fc and h5pfc
    These compile scripts have been modified to change the default behavior to link to shared libraries in environments where HDF5 has been configured with --disable-static.

    Command-line Tools with Changed Behavior

    h5dump
    h5dump output now displays
        USER_DEFINED_FILTER
    where it previously displayed UNKNOWN_FILTER.
     
    h5dump now correctly exports subsetted data to a file using the -o, --output option.

    Release 1.8.11 of May 2013 versus Release 1.8.10

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

    New and Changed Functions and Subroutines

    The following new high-level C function has been added:
    This function writes a data chunk directly into a file, bypassing hyperslab selection, data conversion, and the filter pipeline. The user must be careful with the function and clearly understand the I/O process of the library. See “Direct Chunk Write” for additional information.

    H5DOwrite_chunk is the first function in HDF5’s new high-level “HDF5 Optimized Functions” library.

    The following new C functions have been added:
    These functions scatter data to and gather data from a selection within a memory buffer.

    The following new Fortran subroutines have been added:
    Fortran90 subroutines:
    • h5odecr_refcount_f
    • h5oexists_by_name_f
    • h5oget_comment_f
    • h5oget_comment_by_name_f
    • h5oincr_refcount_f
    • h5oopen_by_idx_f
    • h5oset_comment_f
    • h5oset_comment_by_name_f
     
    • h5oclose_f was introduced in HDF5 Release 1.8.8 but remained undocumented until this release.
     
    Fortran2003 subroutines:
    • h5oget_info_f
    • h5oget_info_by_idx_f
    • h5ovisit_by_name_f

    New Feature: Dynamically Loaded Filters

    HDF5 now detects and dynamically loads external filters, reducing the need for an application to register custom filters or for a developer building on HDF5 to compile a custom filter into a customized HDF5 distribution.

    See “HDF5 Dynamically Loaded Filters” (PDF only) for further information.

    New Command-line Tool Option

    h5dump and h5import
    h5dump has a new option to output the DDL structure of a file or object:
       -O<file_name>
       --ddl=<file_name>
    [‘-O’ above is ‘dash-uppercase-o’.]

    h5import can now take the output of
       h5dump -O<ddl_file_name> -o<data_file_name>
    directly as input files.
    See “Using h5dump to create input for h5import” in the h5import reference manual entry.

    New Configuration and Build Tool

    cmakehdf5
    This new build command script is similar to buildhdf5 and is available in the bin/ directory of the distributed source code.

    For HDF5, the CMake minimum is now 2.8.10.

    Function, Subroutines, and Feature with Changed Syntax or Behavior

    The return value of the following high-level C function has changed:
    This function has been changed to not include the NULL terminator in the returned size of of the dimension scale name (bug fix).

    In the Fortran subroutines
    • h5pset_external_f and
    • h5pget_external_f
    the type of the offset parameter has changed to INTEGER(KIND=OFF_T) to support 8-byte integers, matching the C type definition of off_t.

    The HDF5 Library now supports data conversion from enumeration to integer and floating-point numeric datatypes.

    Command-line Tools with Changed Behavior

    h5diff
    When comparing two files or objects, h5diff now recognizes a unique extra attribute attached to an object as a difference and returns with an exit code of 1.

    Previously, h5diff did not recognize the extra attribute as a difference.

    h5ls
    The content of the h5ls --help output has been revised.

    h5dump
    h5dump has been updated to display the compression ratio for user-defined filters.
    In h5dump output, UNKNOWN_FILTER has been changed to USER_DEFINED_FILTER.

    Removed Functions and Wrappers

    The following C functions and the corresponding C++ wrappers have been removed:
    • H5Pset_dxpl_multi
    • H5Pget_dxpl_multi
       
    • H5::DSetMemXferPropList:setMulti
    • H5::DSetMemXferPropList:getMulti

    Release 1.8.10 of November 2012 versus Release 1.8.9

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

    New and Changed Functions and Subroutines

    The following new C function has been added:
  • H5Pget_mpio_no_collective_cause
  • The following new Fortran subroutine has been added:
  • h5pget_mpio_actual_io_mode_f
  • The syntax of the following high-level C function has changed:
  • H5TBAget_fill
    This function’s return type has been changed to h5tri_t. A return value of 1 indicates that a fill value is present, 0 indicates that no fill value is present, and a negative value indicates an error. (The former return type was herr_t.)

    Note that H5TBAget_fill and a companion function H5TBAget_title, both in the HDF5 Table (H5TB) high-level API, are undocumented. These functions will be added to the HDF5 Reference Manual shortly after HDF5 Release 1.8.10.

  • Changed Command-line Tool

    h5import has been updated to accept an input file created by h5dump.

    Release 1.8.9 of May 2012 versus Release 1.8.8

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

    New and Changed Functions

    A new high level C function and Fortran subroutine were added to HDF5 Lite (H5LT) to determine whether an HDF5 path is correct and resolves to a valid HDF5 object:

    The new file image operations feature consists of the following functions and their associated callbacks, struct, and ENUM. This feature enables an application to load a file into memory (as a file image) and to operate on that file image without the overhead of disk I/O. This feature provides the following functions:
      
     
    For the callbacks, struct, and ENUM, see H5Pset_file_image_callbacks.
    Use of this feature is described in “HDF5 File Image Operations” (PDF).
     

    The following functions were modified or added to the HDF5 Library to allow an application to control the operation of copying committed datatypes with H5Ocopy:
    Function with changed interface:
    New flag for use with H5Pset_copy_object:
    Function with changed behavior:
    • H5Ocopy
      This function’s behavior is changed, but only with the use of the new flag, H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG.
    New functions and callback function:
     
    Use of this capability is described in “Copying Committed Datatypes with H5Ocopy” (PDF).
     

    The following C functions and Fortran subroutines were added to provide a mechanism to ensure sequential consistency in parallel environments using MPI I/O:
     
    Use of this capability is described in “Enabling a Strict Consistency Semantics Model in Parallel HDF5” (PDF).
     

    The following function was added at Release 1.8.5 but was not documented at that time. It is mentioned here for those who may have missed its introduction:

    New Fortran Subroutines

    The following Fortran subroutines have been added in this release: Where a subroutine is part of a new HDF5 feature, that feature is described above.

    Fortran Subroutine with Changed Behavior

    The content of the buffer returned by the following Fortran subroutine has changed as noted:
    • h5ltget_attribute_string_f
      If the returned buffer requires padding, h5ltget_attribute_string_f now employs space padding; this buffer was previously returned with a C NULL terminator.

    Command-line Utilities with New Options and/or Changed Behavior

    h5repack has one new option and improved performance under certain circumstances:
    • ‐Mn, ‐‐metadata_block_size=n
      Sets the metadata block size in the output file.
       
    • Performance is improved when repacking large chunked datasets (for example, when dataset size exceeds 128 MB).
     
    h5stat has one new option:
    • ‐S, ‐‐summary
      Displays a summary of file space usage for a file.
     
    h5dump has one new option, a new capability, and updated output:
    • ‐‐no-compact-subset
      Disables compact subsetting to allow the left-hand square bracket character ( [ ) in a dataset name.
       
    • The files parameter now accommodates wildcards. With this change, h5dump command-line options can be applied across multiple files without listing the files individually.
       
    • h5dump output has been updated for this release to improve compliance with the HDF5 DDL specification and to improve readablilty. This output is now fully compliant with the HDF5 DDL specification, but these changes may affect some user scripts:
      • Whitespace has been modified.
      • Display errors, such as misplaced brackets, have been fixed.
      • When printing superblock content, user block content is now properly displayed within the superblock.

    Release 1.8.8 of November 2011 versus Release 1.8.7

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

    New C Functions

    Two new parallel I/O functions enable an application to query whether or how a collective I/O operation actually completed:

    Updated Fortran Interface, including Fortran 2003 Features

    The HDF5 Fortran interface has been extended and upgraded to Fortran 2003 for this release.

    See “Configure and Build Changes” below for the configure options to use when building HDF5 with Fortran 2003 enabled.

    Features enabled in this upgrade are described in New Features in the HDF5 Fortran Library: Adding Support for the Fortran 2003 Standard (PDF only). In general, the links below are to technical descriptions (reference manual entries, for example) of specific interfaces.

    Terminology: If the Fortran compiler in use is Fortran 2003 compliant and the installed HDF5 Library was configured using both the --enable-fortran and --enable-fortran2003 flags, the resulting HDF5 Fortran Library is referred to below as a Fortran 2003 environment. Without either of the Fortran 2003 compliant compiler or the --enable-fortran2003 flag, the resulting HDF5 Fortran Library is referred to below as a Fortran 90 environment.

    New Fortran 2003-only subroutines
    New subroutines available only in Fortran 2003 environments:

    Subroutines with Fortran 90 versions and extended features in Fortran 2003 environments
    Subroutines in this section have extended support in Fortran 2003 environments, but are new or unchanged in Fortran 90 environments.

    All existing Fortran 90 subroutines, including those not mentioned below, are available in both Fortran 90 and Fortran 2003 environments.

    Subroutines with support for the derived type C_PTR in Fortran 2003 environments:

    Subroutines with support for the derived type C_PTR and a changed signature in Fortran 2003 environments:

    Subroutine with additional optional parameters in Fortran 2003 environments:

    New and updated Fortran 90 subroutines
    New Fortran 90 subroutines:

    Updated Fortran 90 subroutines:

    * h5close_f has been modified in this release to close only the HDF5 Fortran Library interface; it no longer closes the underlying HDF5 Library.

    New Fortran utility functions and derived types
    New Fortran utility functions:

    • h5offsetof         Available only in Fortran 2003 environments.
    • h5kind_to_type     Available in either Fortran environment.

    New Fortran derived types in Fortran 2003 environments:

    New high level Fortran interface
    New Fortran subroutines in the HDF5 Dimension Scale high-level interface, H5DS:

    • h5dsset_scale_f
    • h5dsattach_scale_f
    • h5dsdetach_scale_f
    • h5dsis_attached_f
    • h5dsis_scale_f
    • h5dsset_label_f
    • h5dsget_label_f
    • h5dsget_scale_name_f
    • h5dsget_num_scales_f

    These subtroutines are available in both Fortran 90 and Fortran 2003 environments.

    C Functions with Changed Capability

    H5Tcreate now supports fixed-length and variable-length string types.

    Driver Changes on Windows Systems

    Changed behavior:
    HDF5’s Windows driver has been modified in this release to be a wrapper of the POSIX-compliant SEC2 driver. This change should be transparent to all user applications.

    New default driver:
    As of this release, the default driver on Windows systems is changed to SEC2; it had previously been the Windows driver.

    If you wish to use the Windows driver in an application, it remains fully available. In such cases, the driver must be set explicitly with a H5Pset_fapl_windows call.

    Command-line Utilities with Changed Behavior

    h5jam now checks the file that is to be inserted into the user block and does not allow the insertion if it is an HDF5 file. This is necessary because an HDF5 file in the user block will make the original HDF5 portion of the file inaccessable.

    h5diff with the --delta option reports two NaN values as equal regardless of the type of NaN (as described in the reference manual entry).

    h5diff, when comparing a file to itself, now reports no differences.

    Configure and Build Changes

    configure now uses the same flags and symbols in its tests as are used to build the library.

    To build HDF5 with the Fortran 2003 interfaces requires the use of two configure options:
        --enable-fortran  
        --enable-fortran2003  
    Note that building the Fortran 2003 interfaces requires a Fortran 2003-capable compiler and that --enable-fortran2003 cannot be used alone.

    The --enable-h5dump-packed-bits configure option has been removed. The code that this option enabled is now always compiled into h5dump.

    When building on Linux systems, the HDF5 Library now links with the bsd_compat library.

    Parallel Library and Configuration Changes

    The parallel HDF5 library now always compiles code to take advantage of MPI functionalities that allow for the use of complex derived datatypes during IO and that allow for collective IO when one or more processes do not contribute to the operation.

    This was previously conditionally compiled into the library and controlled by configure via the hdf5_cv_mpi_special_collective_io_works and hdf5_cv_mpi_complex_derived_datatype_works cache values. These values were preset in the config/* files based on the compiler and/or system or could be set on the configure line. Support for these cache values has been removed and they no longer have an effect on the compilation of the use of these MPI functionalities.


     
     

    Release 1.8.7 of May 2011 versus Release 1.8.6

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

    New C Functions and Macros

    Three new functions enable the caching of files opened through external links. This cache can improve the performance of external links in heavy use cases:  
    Two new macros enable compile-time inclusion or exclusion of code depending on the version of the HDF5 Library against which an application is to be linked:

    C Functions with Changed Capability

    HDF5 now allows the size of any dataspace dimension to be 0 (zero). This was previously allowed only if the maximum size of the dimension was unlimited. Though their signatures have not changed, the range of valid parameter values is affected for the following functions: Note that no data can be written to a dataset in which the size of any dimension is set to zero.
     
    In the logging file driver, implementation of the following flags has been completed: H5FD_LOG_TIME_OPEN, H5FD_LOG_TIME_READ, H5FD_LOG_TIME_WRITE, and H5FD_LOG_TIME_SEEK
    Two new flags have been added: H5FD_LOG_NUM_TRUNCATE and H5FD_LOG_TIME_STAT.
     
    HDF5 now blocks committing a datatype that cannot hold any data. This currently includes compound datatypes with no fields and enumerated datatypes with no members. HDF5 has long blocked creating a dataset or attribute with such a datatype.

    Fortran Subroutines with Changed Capability

    Several h5ltmake_dataset*_f and h5ltread_dataset*_f subroutines have been modified to allow them to create or read arrays of up to seven dimensions. They had previously been limited to three dimensions.
        
  • h5ltmake_dataset_f
  • h5ltmake_dataset_int_f
  • h5ltmake_dataset_float_f
  • h5ltmake_dataset_double_f
  •     
  • h5ltread_dataset_f
  • h5ltread_dataset_int_f
  • h5ltread_dataset_float_f
  • h5ltread_dataset_double_f
  •  
    h5tbget_field_info_f has a new maxlen_out parameter. This parameter is optional.

    Command-line Utilities with New Options

    h5diff has a new verbose with levels option to display additional attribute information:
    • -vn, --verbose=n
     
    h5dump has one new option to enable reporting of the HDF5 Library’s error stack:
    • --enable-error-stack

    Command-line Utility with Changed Option Name

    h5ls has one changed option name:
    • --enable-error-stack replaces --error.
    The --error option is deprecated but remains available.

    Command-line Utilities with Changed Behavior

    Attribute comparison with h5diff has been corrected to compare all attributes with common names when comparing objects. Previously, h5diff compared attributes correctly only when two objects had the same number of attributes and all attribute names were identical; if there was either a value or name difference between two attributes, subsequent attributes were not compared.

    h5diff --use-system-epsilon now employs the formula '|a - b|' instead of '|a - b| / b'.

    h5copy now accepts the same file as the source and target file; this enables object copying within a file.

    h5dump now displays reference types as described in DDL in BNF for HDF5:
         H5T_REFERENCE {H5T_STD_REF_OBJ} Object reference
      H5T_REFERENCE {H5T_STD_REF_DSETREG}   Dataset region reference

    Configure and Build Changes

    Configure now generates Makefiles that build in silent make mode by default. In this mode, compile and link lines are significantly simplified for clarity. You can opt out of this default with either of the following approaches:

    The new configure option --enable-unsupported can be used to stop configure from preventing the use of unsupported configure option combinations. For example, use of this option enables building HDF5 with the unsupported and untested configurations of C++ in a parallel environment or Fortran with a threadsafe library.

    Parallel HDF5

    mpicc and mpif90 are now the default C and Fortran compilers on Linux systems when --enable-parallel is specified but no $CC or $FC is defined.

    Release 1.8.6 versus Release 1.8.5, February 2011

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

    C Functions with Additional Capability

    H5Tset_order and H5Tget_order can now be used with all datatypes. See the related note regarding H5T_ORDER_MIXED immediately below.

    ENUM with New Member

    H5T_order_t, an ENUM used to set or indicate datatype endianness, includes a new member:

         H5T_ORDER_MIXED

    The function H5Tget_order returns this value when called on a compound datatype whose members are not all of the same endianness.

    Command-line Utilities with New Options

    h5diff has one new option:
    • --exclude-path

    h5ls and h5diff have two new options:
    • --follow-symlinks
    • --no-dangling-links

    Command-line Utilities with Changed Behavior

    h5diff now compares member objects and groups recursively when two files or groups are specified to be compared.

    h5ls now displays object and attribute names exactly as stored in the file rather than interpreting them for output. For example, if an attribute is named \ttemp in the file, h5ls will output that name as \ttemp rather than converting the leading \t to a tab.

    h5repack can now convert a dataset to compact layout.

    Compiler Script Arguments and Environment Variables

    h5cc, h5fc, h5c++, h5pcc, and h5pfc arguments have been expanded to enable the user to add compiler and linker flags that will take precedence over the flags from the HDF5 build.

    The arguments CPPFLAGS, CFLAGS, LDFLAGS, and LIBS have been duplicated with the prefix H5BLD_ to put the flags and paths from the HDF5 build in the correct places and to allow the script user to add entries in CPPFLAGS, CFLAGS, LDFLAGS, and LIBS that will take precedence over those from the HDF5 build. Changes to these entries can be made persistent by editing CFLAGSBASE, CPPFLAGSBASE, LDFLAGSBASE, and LIBSBASE near the top of the script. If the change is to be temporary, the user can set HDF5_CFLAGS, HDF5_CPPFLAGS, HDF5_LDFLAGS, or HDF5_LIBS in the environment.

    The new order of arguments for these scripts is as follows:

            $CLINKER 
            $H5BLD_CPPFLAGS 
            $CPPFLAGS 
            $H5BLD_CFLAGS 
            $CFLAGS 
            $LDFLAGS 
            $clibpath 
            $link_objs 
            $LIBS 
            $link_args 
            $shared_link
                

    Thread Safety on Windows

    This release adds support for thread safety on Windows using the Windows threads library. See the file RELEASE.txt in the distributed HDF5 source code (hdf5/release_docs/RELEASE.txt) for details.

    Parallel HDF5

    The Parallel HDF5 build process has changed to use mpiexec instead of mpirun.

    Release 1.8.5 versus Release 1.8.4, June 2010

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

    New C Function

    The following function was added to the HDF5 Library at this release, but was not documented at that time: (This note added in November 2011, shortly following Release 1.8.8.)

    C Functions with Additional Capability

    The following functions have been modified to accommodate filters set on a group creation property list:
    H5Pall_filters_avail
    H5Pget_filter1
    H5Pget_filter2
    H5Pget_filter_by_id1
    H5Pget_filter_by_id2
    H5Pget_nfilters
         H5Pmodify_filter
    H5Premove_filter
    H5Pset_deflate
    H5Pset_filter
    H5Pset_fletcher32

    Related to H5Zregister, the calling protocol for the can_apply and set_local callback functions has been extended to accommodate the use of filters on group creation property lists.

    New C++ Member Function and Overloaded Member Functions

    The following C++ member function is new in this release:
    DataSet::getInMemDataSize    To simplify getting a dataset’s data size in memory.

    The overloaded forms of the following C++ member functions are new in this release:
    CommonFG::getObjnameByIdx    Overloaded to take char* for name.
    CommonFG::getObjTypeByIdx    Overloaded to return type name as a char*.

    Command-line Utility with New Options

    h5diff has two new options:
    • --follow-links
    • --no-dangling-links

    Fortran Subroutines with Changed Interface

    The link type parameter values associated with the following Fortran subroutines have changed in this release:
    • h5lget_info_f
    • h5lget_info_by_idx_f

    • Valid values for the parameter link_type have changed to the following:
           H5L_TYPE_HARD_F
           H5L_TYPE_SOFT_F
           H5L_TYPE_EXTERNAL_F
           H5L_TYPE_ERROR_F
      These values previously began with the string 'H5L_LINK_'.

    CMake

    This release includes an adaptation enabling HDF5 builds with CMake. This early-stage adaptation is distributed to provide an opportunity for early access and experimentation; the CMake-related files should not be viewed as final and may change before the next release.

    While the initial development effort has been focussed on Microsoft Windows platforms, the HDF5 Library has been successfully built with CMake on Linux and Mac OS X.

    See the file CMake.txt in the distributed HDF5 source code (hdf5/release_docs/CMake.txt) for details.

    Release 1.8.4 versus Release 1.8.3, November 2009

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

    Embedded HDF5 Library Settings Information

    Library settings are now embedded in an HDF5 executable so that an “orphaned” executable can be queried (via the Unix strings command, for example) to display the library settings used to build it. The embedded settings information is the same as that normally found in the libhdf5.settings file.

    This capability may be disabled with the use of the --disable-embedded-libinfo flag during configure.

    New Fortran Subroutine and Constant

    The following Fortran subroutine is new in this release: h5oopen_by_addr_f
    The following Fortran constant, corresponding to the C constant H5T_ORDER_NONE, has been added in this release: H5T_ORDER_NONE_F

    New C++ Member Functions

    New C++ member functions are provided to determine a dataset’s or attribute’s data size in memory: size_t DataSet::getInMemDataSize() const
    size_t Attribute::getInMemDataSize() const
    The size in each case is in bytes.

    Function with Changed Interface or Behavior

    H5check_version now displays embedded library information (see above) if a version mismatch is detected.

    The function has also been changed to suppress the warning message entirely if $HDF5_DISABLE_VERSION_CHECK is set to 2 or higher.

    Fortran Subroutines with Changed Syntax

    The following Fortran subroutines have changed syntax in this release:
    • h5lget_info_f
    • The type of the parameter address has changed from INTEGER to INTEGER(HADDR_T).
      (This note added on 13 January 2010.)

    • h5lget_info_by_idx_f
    • h5lget_info_by_idx_f (loc_id, group_name, index_field, order, n, &
           link_type, f_corder_valid, corder, cset, address, val_size, &
           hdferr, lapl_id)

      The parameters link_type, address, and val_size have been added; the parameter data_size has been removed.

    Tools with Changed Interface or Behavior

    h5diff has one new option: --use-system-epsilon

    With this option, h5diff returns a difference if and only if the difference between two data values exceeds the system value for epsilon (that is, if |a-b| > epsilon).

    The tool’s default behavior has also changed; without this option, the tool now checks for strict equality. Prior default behavior was to use an epsilon internally defined in HDF5.

    This option has no short form.

    h5dump has one new option and the behavior of another set of options has changed: -R or --region

    With this option, h5dump prints the data pointed to by a region reference. Without this option, h5dump prints only the reference.

    Usage of the subsetting parameters has changed. All of START, STRIDE, COUNT, and BLOCK now have default values. If those defaults are satisfactory, h5dump no longer requires that all four be specifiespecified when subsetting a dataset.

    Changed Library Configuration

    The following configuration flag is new with this release: --disable-embedded-libinfo This flag disables the embedding of HDF5 Library settings in an HDF5 executable.

    Release 1.8.3 versus Release 1.8.2, May 2009

    This section lists API-level changes and changes in behavior in the transition from HDF5 Release 1.8.2 to Release 1.8.3.

    New Functions

    C functions:
    The following C functions are new for this release and are documented in the HDF5 Reference Manual.
         H5Pset_elink_cb           herr_t H5Pset_elink_cb( hid_t lapl_id, H5L_elink_traverse_t func, void *op_data )
    See entry.
         H5Pget_elink_cb           herr_t H5Pget_elink_cb( hid_t lapl_id, H5L_elink_traverse_t *func, void **op_data )
    See entry.
         H5Pset_elink_acc_flags           herr_t H5Pset_elink_acc_flags( hid_t lapl_id, unsigned flags )
    See entry.
         H5Pget_elink_acc_flags           herr_t H5Pget_elink_acc_flags( hid_t lapl_id, unsigned *flags )
    See entry.
         H5Pset_chunk_cache           herr_t H5Pset_chunk_cache( hid_t dapl_id, size_t rdcc_nslots, size_t rdcc_nbytes, double rdcc_w0 )
    See entry.
         H5Pget_chunk_cache           herr_t H5Pget_chunk_cache( hid_t dapl_id, size_t *rdcc_nslots, size_t *rdcc_nbytes, double *rdcc_w0 )
    See entry.
         H5Dget_access_plist           hid_t H5Dget_access_plist( hid_t dset_id )
    See entry.
         H5Iis_valid           htri_t H5Iis_valid( hid_t id )
    See entry.

    Fortran Subroutines:
    The following subroutines are new in this release: h5dget_access_plist_f  
    h5iis_valid_f  
    h5pset_chunk_cache  
    h5pget_chunk_cache  

    Function with Changed Behavior

    H5set_free_list_limits
    The HDF5 Library now dynamically creates separate factory free lists to manage blocks of a fixed size; these blocks were previously managed within the blockfree lists. Factory free lists use the same settings as specified in H5set_free_list_limits for block free lists.

    While the API has not changed, users may see both a performance boost and increased memory usage.

    Tools with Changed Interface or Behavior

    h5diff
    The default behavior of h5diff is now to detect and compare NaNs. Use the -N or --nan option (below) to turn this behavior off and avoid the performance penalty that NaN detection and comparison entalis. (NaN detection and comparison became the default in in HDF5 Release 1.6.8.)

    This tool has two new options:

         -c, --compare      Lists objects that are not comparable.

         -N, --nan          Avoids NaNs detection.

    h5dump
    h5dump now correctly specifies an XML DTD or a schema URL.

    h5dump binary output now defaults to NATIVE.

    The new -b, --binary option can be used to specify alternate binary formats.

    h5repack
    When a user does not specify a chunk size, h5repack now defines the default chunk size to be the same same as the size of the hyperslab used to read the chunks.

    Release 1.8.2 versus Release 1.8.1, November 2008

    This section lists API-level changes and changes in behavior in the transition from HDF5 Release 1.8.1 to Release 1.8.2.

    New Functions

    C functions:
    The following C functions are new for this release and are documented in the HDF5 Reference Manual.
         H5Pset_elink_fapl           herr_t H5Pset_elink_fapl( hid_t lapl_id, hid_tfapl_id )
    See entry.
      H5Pget_elink_fapl        hid_t H5Pget_elink_fapl( hid_t lapl_id )
    See entry.

    Fortran Subroutine:
    The following subroutine is new in this release:
         H5Tget_native_type_f

    New C++ Wrappers

    The following functions were added as wrappers for the C function H5Rdereference to replace the incorrect IdComponent::dereference():
            void H5Object::dereference(H5Object& obj, void* ref, 
                                       H5R_type_t ref_type=H5R_OBJECT)
            void H5Object::dereference(H5File& h5file, void* ref, 
                                       H5R_type_t ref_type=H5R_OBJECT)
            void H5Object::dereference(Attribute& obj, void* ref, 
                                       H5R_type_t ref_type=H5R_OBJECT)
                    

    The following constructors were added to create the associated objects by way of dereference:

            DataSet(H5Object& obj, void* ref, H5R_type_t ref_type=H5R_OBJECT)
            DataSet(H5File& file, void* ref, H5R_type_t ref_type=H5R_OBJECT)
            DataSet(Attribute& attr, void* ref, H5R_type_t ref_type=H5R_OBJECT)
            Group(H5Object& obj, void* ref, H5R_type_t ref_type=H5R_OBJECT)
            Group(H5File& obj, void* ref, H5R_type_t ref_type=H5R_OBJECT)
            Group(Attribute& attr, void* ref, H5R_type_t ref_type=H5R_OBJECT)
            DataType(H5Object& obj, void* ref, H5R_type_t ref_type=H5R_OBJECT)
            DataType(H5File& file, void* ref, H5R_type_t ref_type=H5R_OBJECT)
            DataType(Attribute& attr, void* ref, H5R_type_t ref_type=H5R_OBJECT)
                    

    Functions with Changed Syntax

    The following function syntaxes have changed; the affected return values and parameter are noted as underscored red text.

    C functions:
    H5Fget_obj_count
    ssize_t H5Fget_obj_count( hid_t file_id, unsigned int types )

    H5Fget_obj_ids
    ssize_t H5Fget_obj_ids( hid_t file_id, unsigned int types,
            size_t max_objs, hid_t *obj_id_list )

    Changed Fortran Subroutines

    The optional parameter mounted has been added to the following subroutines:
    h5gget_info_f
    h5gget_info_by_idx_f
    h5gget_info_by_name_f     

    Changed Data Structure

    H5G_info_t
    A mounted filed has been added to the H5G_info_t struct.

    Tools with Changed Interface or Behavior

    h5diff
    h5diff now returns 1 if the files differ in structure, i.e., if the file graphs differ by any object.

    The tool’s error return code has been changed to 2.

    h5repack and h5diff
    The standard command-line syntax of both tools has been changed to parallel that of h5dump. The new syntax of each is as follows:

         h5repack [OPTIONS] file1 file2

         h5diff [OPTIONS] file1 file2 [object1 [object2]]

    In each case, the old syntax remains available (though undocumented) to avoid breaking existing scripts.

    h5repack
    The following new options control the addition of user block data to an existing HDF5 file:
    -u U
    --ublock=U
         Specifies the name of the file containing the user block data to be added.

    -b B
    --block=B
        
    Specifies the size of the block to be added.

    The following new options set parameters governing the tool’s use of H5Pset_alignment:
    -t T
    --threshold=T
         Specifies the threshold value for H5Pset_alignment.

    -a A
    --alignment=A
        
    Specifies the alignment value for H5Pset_alignment.

    h5repack now supports multiple instances of the '-f' or '--filter' option, allowing the use of multiple I/O filters with an object.

    With no change in the command-line syntax, h5repack now retains an existing userblock when repacking an HDF5 file.

    h5import
    The floating point format flag TEXTFPE, for scientific notation, has been deprecated. The flag TEXTFP, which accepts scientific notation, should be used instead.

    h5import now imports string data with the STR keyword in the INPUT-CLASS configuration field.

    h5dump and h5ls
    These tools now traverse external links when performing recursive traversals.

    h5dump
    Binary output now defaults to NATIVE with the '-b' option, optionally accepting NATIVE, FILE, BE, and LE.

    The new '-m T' or '--format T' option enables a user-defined formatting string for printing floating-point numbers.

    With no change in the command-line syntax, h5dump now prints a compression ratio when compression filters are in use.

    Deprecated Functions

    The following functions are deprecated as of this release:
            H5Pset_preserve
            H5Pget_preserve 

    The original role of these functions is now part of the core HDF5 Library functionality.

    Changed File Installation

    The file libhdf5_fortran.settings is no longer installed with the HDF5 Library; the original content of that file is now included in libhdf5.settings.

    Changed Library Configuration

    It is no longer necessary to manually set an SZIP library path in LD_LIBRARY_PATH when building HDF5 with shared SZIP libraries; configure will determine the correct path from the --with-szlib flag, prepending it to and exporting LD_LIBRARY_PATH.

    Note that if an SZIP library path is set in a user-supplied LD_LIBRARY_PATH, in an existing script, for example, that does not necessarily need to be changed; configure will prepend the SZIP library path extracted from --with-szlib to the user-supplied LD_LIBRARY_PATH.


    Release 1.8.1 versus Release 1.8.0

    HDF5 Release 1.8.1 is a minor release with several bugfixes and optimizations and limited new features.

    The most significant new feature is an expanded set of Fortran90 APIs, enabling essentially all new C library features of Release 1.8.0.

    New Functions and Tools

    C functions:
    There are no new C functions for Release 1.8.1.

    Fortran subroutines:
    The following Fortran subroutines are new for Release 1.8.1 and are documented in the HDF5 Reference Manual.

    H5A
    h5acreate_f
    h5acreate_by_name_f
    h5adelete_by_idx_f
    h5adelete_by_name_f
    h5aexists_f
    h5aexists_by_name_f
    h5aget_create_plist_f
    h5aget_info_f
    h5aget_info_by_idx_f
                      
     
    h5aget_info_by_name_f
    h5aget_name_by_idx_f
    h5aget_storage_size_f
    h5aopen_f
    h5aopen_by_idx_f
    h5aopen_by_name_f
    h5arename_f
    h5arename_by_name_f
                      
    H5D
    h5dcreate_anon_f
    h5dcreate_f
                      
     
    h5dopen_f
    h5dset_extent_f
                      
    H5G
    h5gcreate_anon_f
    h5gcreate_f
    h5gget_create_plist_f
    h5gget_info_f
                      
     
    h5gget_info_by_idx_f
    h5gget_info_by_name_f
    h5gopen_f
                      
    H5L
    h5lcopy_f
    h5lcreate_external_f
    h5lcreate_hard_f
    h5lcreate_soft_f
    h5ldelete_f
    h5ldelete_by_idx_f
                      
     
    h5lexists_f
    h5lget_info_f
    h5lget_info_by_idx_f
    h5lget_name_by_idx_f
    h5lmove_f
                      
    H5O
    h5olink_f
                      
     
    h5oopen_f
                      
    H5P
    h5pget_attr_creation_order_f
    h5pget_attr_phase_change_f
    h5pget_char_encoding_f
    h5pget_copy_object_f
    h5pget_create_inter_group_f
    h5pget_data_transform_f
    h5pget_elink_prefix_f
    h5pget_est_link_info_f
    h5pget_fapl_direct_f
    h5pget_link_creation_order_f
    h5pget_link_phase_change_f
    h5pget_local_heap_size_hint_f
    h5pget_nlinks_f
    h5pget_obj_track_times_f
    h5pget_shared_mesg_index_f
    h5pget_shared_mesg_nindexes_f
                      
     
    h5pset_attr_creation_order_f
    h5pset_attr_phase_change_f
    h5pset_char_encoding_f
    h5pset_copy_object_f
    h5pset_create_inter_group_f
    h5pset_data_transform_f
    h5pset_elink_prefix_f
    h5pset_est_link_info_f
    h5pset_fapl_direct_f
    h5pset_libver_bounds_f
    h5pset_link_creation_order_f
    h5pset_link_phase_change_f
    h5pset_local_heap_size_hint_f
    h5pset_obj_track_times_f
    h5pset_nbit_f
    h5pset_nlinks_f
    h5pset_scaleoffset_f
                      
    H5R
    h5rget_name_f
                      
     
                      
    H5S
    h5sdecode_f
    h5sencode_f
                      
     
    h5sextent_equal_f
                      
    H5T
    h5tcommit_anon_f
    h5tcommit_f
    h5tcommitted_f
    h5tcompiler_conv_f
                      
     
    h5tdecode_f
    h5tencode_f
    h5tget_create_plist_f
    h5topen_f
                      

    C++ wrappers:
    There are no new C++ wrappers for Release 1.8.1.

    Functions and Tools with Changed Syntax

    C functions with changed syntax:
    There are no C functions with changed syntax in Release 1.8.1.

    Fortran subroutines with changed syntax:
    In the following Fortran subroutines, spos is a new parameter indicating the position of the sign bit:
         h5tset_fields_f(type_id, spos, epos, esize, mpos, msize, hdferr)
         h5tget_fields_f(type_id, spos, epos, esize, mpos, msize, hdferr)

    Changed C++ wrappers:
    • The class AbstractDS was moved out of H5Object.

      The class Attribute now multiply inherits from IdComponent and AbstractDs; the class DataSet now multiply inherits from H5Object and AbstractDs.

      In addition, data member IdComponent::id was moved into subclasses: Attribute, DataSet, DataSpace, DataType, H5File, Group, and PropList.

    • IdComponent::dereference was incorrect; it was changed from:
           void IdComponent::dereference(IdComponent& obj, void* ref)
      to:
           void H5Object::dereference(H5File& h5file, void* ref)
           void H5Object::dereference(H5Object& obj, void* ref)

    Tools with changed syntax:
    • The command-line syntax of h5repack was changed in Release 1.8.0 to the following:
           h5repack [OPTIONS] in_file out_file

      Since this would be imcompatible with existing user scripts, the original syntax has be re-enabled in this release:
           h5repack -i in_file -o out_file [OPTIONS]

      h5repack now understands either syntax.

    • An h5repack option to set the minimum number of links in indexed format was introduced in Release 1.8.0 as '-d min_indexed_links' or '--indexed=min_indexed_links'. In Release 1.8.1, the '-i' form has been changed to '-d' as follows:
           -d min_indexed_links
      or
           --indexed=min_indexed_links

    • The command-line syntax of h5diff was changed in Release 1.8.0 to the following:
           h5diff [OPTIONS] file1 file2 [object1 [object2 ] ]

    Tools with new options:
    • h5dump -m T  or  --format T   Sets format of floating point output

    Changed Behavior or Output

    Changed library behavior:
    A 4GB limit on the size of dataset chunks is now properly enforced when a dataset is created.

    The HDF5 Library now works more effectively with external links. Some valid external links that previously failed will now be properly recognized. See H5Lcreate_external.

    C functions with changed behavior:
    The behavior of H5Lcreate_external has changed as described immediately above.

    Tools with changed behavior and changed output:
    The h5dump -p option now prints the compression ratio if a compression filter is associated with a dataset.

    h5dump now supports external links, displaying the target objects (datasets, groups, and named datatypes).

    Tools with changed output:

    Changed Library Configuration

    The following configuration flag is new with this release:
    --disable-sharedlib-rpath

    Removed Patch Requirement

    The patch that was required for Cygwin with HDF5 Release 1.8.0 has been rolled into this release and no longer needs to be applied by the user.

    Release 1.8.0 versus Release 1.6.x

    HDF5 Release 1.8.0 is a major release with several new features and a variety of bugfixes, optimizations, and portability enhancements.

    See the document “What’s New in HDF5 1.8.0” for a high-level overview of the new functionality in this release. The following pages assume a familiarity with that overview.

    This section provides details of the API-level changes that have been made in the transition to HDF5 Release 1.8.0 from the Release 1.6.x series.

    API Compatibility Macros with Associated Renamed and New Functions

    Release 1.8.0 introduces API compatibility macros designed to facilitate application migration. These macros are intended to facilitate developer management of a clean, step-by-step migration from an older HDF5 Library to the new release; they can also be used to enable older applications to use the new library without requiring that the application be rewritten. See API Compatibility Macros in HDF5 for a full description.

    Macros are identified in reference manual function indexes by an italic typeface.

    The new macros and the new and old functions to which they may be mapped are as follows:

    H5Acreate      H5Acreate1 
    H5Acreate2 
    Renamed from H5Acreate
    New
    H5Aiterate      H5Aiterate1 
    H5Aiterate2 
    Renamed from H5Aiterate
    New
    H5Dcreate      H5Dcreate1 
    H5Dcreate2 
    Renamed from H5Dcreate
    New
    H5Dopen      H5Dopen1 
    H5Dopen2 
    Renamed from H5Dopen
    New
    H5Eclear      H5Eclear1 
    H5Eclear2 
    Renamed from H5Eclear
    New
    H5Eget_auto      H5Eget_auto1 
    H5Eget_auto2 
    Renamed from H5Eget_auto
    New
    H5Eprint      H5Eprint1 
    H5Eprint2 
    Renamed from H5Eprint
    New
    H5Epush      H5Epush1 
    H5Epush2 
    Renamed from H5Epush
    New
    H5Eset_auto      H5Eset_auto1 
    H5Eset_auto2 
    Renamed from H5Eset_auto
    New
    H5Ewalk      H5Ewalk1 
    H5Ewalk2 
    Renamed from H5Ewalk
    New
    H5Gcreate      H5Gcreate1 
    H5Gcreate2 
    Renamed from H5Gcreate
    New
    H5Gopen      H5Gopen1 
    H5Gopen2 
    Renamed from H5Gopen
    New
    H5Pget_filter      H5Pget_filter1 
    H5Pget_filter2 
    Renamed from H5Pget_filter
    New
    H5Pget_filter_by_id      H5Pget_filter_by_id1    
    H5Pget_filter_by_id2 
    Renamed from H5Pget_filter_by_id
    New
    H5Pinsert      H5Pinsert1 
    H5Pinsert2 
    Renamed from H5Pinsert
    New
    H5Pregister      H5Pregister1 
    H5Pregister2 
    Renamed from H5Pregister
    New
    H5Rget_obj_type      H5Rget_obj_type1 
    H5Rget_obj_type2 
    Renamed from H5Rget_obj_type
    New
    H5Tarray_create      H5Tarray_create1 
    H5Tarray_create2 
    Renamed from H5Tarray_create
    New
    H5Tcommit      H5Tcommit1 
    H5Tcommit2 
    Renamed from H5Tcommit
    New
    H5Tget_array_dims      H5Tget_array_dims1 
    H5Tget_array_dims2 
    Renamed from H5Tget_array_dims
    New
    H5Topen      H5Topen1 
    H5Topen2 
    Renamed from H5Topen
    New

    (H5Dcreate and H5Dopen added to the above list in November 2010, prior to Release 1.8.6.)

    New Functions and Tools

    C functions:
    The following C functions are new for Release 1.8.0 and, unless otherwise noted, are documented in the HDF5 Reference Manual.

    Recursive iteration
     
    H5Lvisit      herr_t H5Lvisit( hid_t group_id, H5_index_t index_type, H5_iter_order_t order, H5L_iterate_t op, void *op_data )
    See entry.
    H5Lvisit_by_name      herr_t H5Lvisit_by_name( hid_t loc_id, const char *group_name, H5_index_t index_type, H5_iter_order_t order, H5L_iterate_t op, void *op_data, hid_t lapl_id )
    See entry.
    H5Ovisit      herr_t H5Ovisit( hid_t group_id, H5_index_t index_type, H5_iter_order_t order, H5O_iterate_t op, void *op_data )
    See entry.
    H5Ovisit_by_name      herr_t H5Ovisit_by_name( hid_t loc_id, const char *object_name, H5_index_t index_type, H5_iter_order_t order, H5O_iterate_t op, void *op_data, hid_t lapl_id )
    See entry.

    “Format bounds” property
    Release-to-release format compatibility
     
    H5Pset_libver_bounds      herr_t H5Pset_libver_bounds( hid_t fapl_id, H5F_libver_t low, H5F_libver_t high )
    See entry.
    H5Pget_libver_bounds      herr_t H5Pget_libver_bounds( hid_t fapl_id, H5F_libver_t *low, H5F_libver_t *high )
    See entry.

    Configurable compact-or-indexed
    groups (compact and large groups)
     
    H5Pset_link_phase_change      herr_t H5Pset_link_phase_change( hid_t gcpl_id, unsigned max_compact, unsigned min_dense )
    See entry.
    H5Pget_link_phase_change      herr_t H5Pget_link_phase_change( hid_t gcpl_id, unsigned *max_compact, unsigned *min_dense )
    See entry.
    H5Pset_est_link_info      herr_t H5Pset_est_link_info( hid_t gcpl_id, unsigned est_num_entries, unsigned est_name_len )
    See entry.
    H5Pget_est_link_info      herr_t H5Pget_est_link_info( hid_t gcpl_id, unsigned *est_num_entries, unsigned *est_name_len )
    See entry.
    H5Pset_nlinks      herr_t H5Pset_nlinks( hid_t lapl_id, size_t nlinks )
    See entry.
    H5Pget_nlinks      herr_t H5Pget_nlinks( hid_t lapl_id, size_t *nlinks )
    See entry.

    User-defined links
     
    H5Lcreate_ud      herr_t H5Lcreate_ud( hid_t link_loc_id, const char *link_name, H5L_type_t link_type, const char *udata, size_t udata_size, hid_t lcpl_id, hid_t lapl_id )
    See entry.
    H5Lregister      herr_t H5Lregister( const H5L_class_t * link_class )
    See entry.
    H5Lunregister      herr_t H5Lunregister( H5L_type_t link_cls_id )
    See entry.
    H5Oincr_refcount      herr_t H5Oincr_refcount( hid_t object_id )
    See entry.
    H5Odecr_refcount      herr_t H5Odecr_refcount( hid_t object_id )
    See entry.

    External links
     
    H5Lcreate_external      herr_t H5Lcreate_external( const char *file_name, const char *object_name, hid_t link_loc_id, const char *link_name, hid_t lcpl_id, hid_t lapl_id )
    See entry.
    H5Lunpack_elink_val      herr_t H5Lunpack_elink_val( char *ext_linkval, size_t link_size, const char **filename, const char **obj_path )
    See entry.
    H5Pset_elink_prefix      herr_t H5Pset_elink_prefix( hid_t lapl_id, const char *prefix )
    See entry.
    H5Pget_elink_prefix      herr_t H5Pget_elink_prefix( hid_t lapl_id, const char **prefix )
    See entry.

    Link creation order
    tracking and indexing
     
    H5Pset_link_creation_order      herr_t H5Pset_link_creation_order( hid_t ocpl_id, unsigned *crt_order_flags )
    See entry.
    H5Pget_link_creation_order      herr_t H5Pget_link_creation_order( hid_t ocpl_id, unsigned *crt_order_flags )
    See entry.
    H5Gget_create_plist      hid_t H5Gget_create_plist( hid_t group_id )
    See entry.
    H5Gget_info_by_idx      herr_t H5Gget_info_by_idx( hid_t loc_id, const char *group_name, H5_index_t index_type, H5_iter_order_t order, hsize_t n, H5G_info_t *group_info, hid_t lapl_id )
    See entry.
    H5Tget_create_plist      hid_t H5Tget_create_plist( hid_t dtype_id )
    See entry.

    Link API (H5L), an all-new interface
    (includes user-defined and external links)
     
    H5Lcopy      herr_t H5Lcopy( hid_t src_loc_id, const char *src_name, hid_t dest_loc_id, const char *dest_name, hid_t lcpl_id hid_t lapl_id )
    See entry.
    H5Lcreate_external      herr_t H5Lcreate_external( const char *file_name, const char *object_name, hid_t link_loc_id, const char *link_name, hid_t lcpl_id, hid_t lapl_id )
    See entry.
    H5Lcreate_hard      herr_t H5Lcreate_hard( hid_t obj_loc_id, const char *obj_name, hid_t link_loc_id, const char *link_name, hid_t lcpl_id, hid_t lapl_id )
    See entry.
    H5Lcreate_soft      herr_t H5Lcreate_soft( const char *target_path, hid_t link_loc_id, const char *link_name, hid_t lcpl_id, hid_t lapl_id )
    See entry.
    H5Lcreate_ud      herr_t H5Lcreate_ud( hid_t link_loc_id, const char *link_name, H5L_type_t link_type, const char *udata, size_t udata_size, hid_t lcpl_id, hid_t lapl_id )
    See entry.
    H5Ldelete      herr_t H5Ldelete( hid_t loc_id, const char *name, hid_t lapl_id )
    See entry.
    H5Ldelete_by_idx      herr_t H5Ldelete_by_idx( hid_t loc_id, const char *group_name, H5_index_t index_field, H5_iter_order_t order, hsize_t n, hid_t lapl_id )
    See entry.
    H5Lexists      htri_t H5Lexists( hid_t loc_id, const char *name, hid_t lapl_id )
    See entry.
    H5Lget_info      herr_t H5Lget_info( hid_t link_loc_id, const char *link_name, H5L_info_t *link_buff, hid_t lapl_id )
    See entry.
    H5Lget_info_by_idx      herr_t H5Lget_info_by_idx( hid_t loc_id, const char *group_name, H5_index_t index_field, H5_iter_order_t order, hsize_t n, H5L_info_t *link_val, hid_t lapl_id )
    See entry.
    H5Lget_name_by_idx      ssize_t H5Lget_name_by_idx( hid_t loc_id, const char *group_name, H5_index_t index_field, H5_iter_order_t order, hsize_t n, char *name, size_t size, hid_t lapl_id )
    See entry.
    H5Lget_val      herr_t H5Lget_val( hid_t link_loc_id, const char *link_name, void *linkval_buff, size_t size, hid_t lapl_id )
    See entry.
    H5Lget_val_by_idx      ssize_t H5Lget_val_by_idx( hid_t loc_id, const char *group_name, H5_index_t index_field, H5_iter_order_t order, hsize_t n, char *value_buf, size_t size, hid_t lapl_id )
    See entry.
    H5Lis_registered      htri_t H5Lis_registered( H5L_type_t link_cls_id )
    See entry.
    H5Literate      herr_t H5Literate( hid_t loc_id, H5_index_t index_type, H5_iter_order_t order, hsize_t *idx, H5L_iterate_t op, void *op_data )
    See entry.
    H5Literate_by_name      herr_t H5Literate( hid_t loc_id, const char *group_name, H5_index_t index_type, H5_iter_order_t order, hsize_t *idx, H5L_iterate_t op, void *op_data, hid_t *lapl_id )
    See entry.
    H5Lmove      herr_t H5Lmove( hid_t src_loc_id, const char *src_name, hid_t dest_loc_id, const char *dest_name, hid_t lcpl, hid_t lapl )
    See entry.
    H5Lregister      herr_t H5Lregister( const H5L_class_t * link_class )
    See entry.
    H5Lunpack_elink_val      herr_t H5Lunpack_elink_val( char *ext_linkval, size_t link_size, const char **filename, const char **obj_path )
    See entry.
    H5Lunregister      herr_t H5Lunregister( H5L_type_t link_cls_id )
    See entry.
    H5Lvisit      herr_t H5Lvisit( hid_t group_id, H5_index_t index_type, H5_iter_order_t order, H5L_iterate_t op, void *op_data )
    See entry.
    H5Lvisit_by_name      herr_t H5Lvisit_by_name( hid_t loc_id, const char *group_name, H5_index_t index_type, H5_iter_order_t order, H5L_iterate_t op, void *op_data, hid_t lapl_id )
    See entry.

    Enhanced attribute handling
     
    H5Acreate2      hid_t H5Acreate2( hid_t loc_id, const char *obj_name, const char *attr_name, hid_t type_id, hid_t space_id, hid_t acpl_id, hid_t aapl_id, hid_t lapl_id )
    See entry.
    H5Adelete_by_idx      herr_t H5Adelete_by_idx( hid_t loc_id, const char *obj_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, hid_t lapl_id )
    See entry.
    H5Adelete_by_name      herr_t H5Adelete_by_name( hid_t loc_id, const char *obj_name, const char *attr_name, hid_t lapl_id )
    See entry.
    H5Aget_info      herr_t H5Aget_info( hid_t attr_id, H5A_info_t *ainfo )
    See entry.
    H5Aget_info_by_idx      herr_t H5Aget_info_by_idx( hid_t loc_id, const char *obj_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, H5A_info_t *ainfo, hid_t lapl_id )
    See entry.
    H5Aget_info_by_name      herr_t H5Aget_info_by_name( hid_t loc_id, const char *obj_name, const char *attr_name, H5A_info_t *ainfo, hid_t lapl_id )
    See entry.
    H5Aget_name_by_idx      ssize_t H5Aget_name_by_idx( hid_t loc_id, const char *obj_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, char *name, size_t size, hid_t lapl_id )
    See entry.
    H5Aget_storage_size      hsize_t H5Aget_storage_size( hid_t attr_id )
    See entry.
    H5Aiterate2      herr_t H5Aiterate2( hid_t obj_id, H5_index_t idx_type, H5_iter_order_t order, hsize_t *n, H5A_operator2_t op, void *op_data )
    See entry.
    H5Aiterate_by_name      herr_t H5Aiterate_by_name( hid_t loc_id, const char *obj_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t *n, H5A_operator2_t op, void *op_data, hid_t lapd_id )
    See entry.
    H5Aopen      herr_t H5Aopen( hid_t loc_id, const char *obj_name, const char *attr_name, hid_t aapl_id, hid_t lapl_id )
    See entry.
    H5Aopen_by_idx      herr_t H5Aopen_by_idx( hid_t loc_id, const char *obj_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, hid_t aapl_id, hid_t lapl_id )
    See entry.
    H5Arename_by_name      herr_t H5Arename_by_name( hid_t loc_id, const char *obj_name, const char *old_attr_name, const char *new_attr_name, hid_t lapl_id )
    See entry.

    Managing large numbers of attributes
     
    H5Pset_attr_phase_change      herr_t H5Pset_attr_phase_change( hid_t ocpl_id, unsigned max_compact, unsigned min_dense )
    See entry.
    H5Pget_attr_phase_change      herr_t H5Pget_attr_phase_change( hid_t ocpl_id, unsigned *max_compact, unsigned *min_dense )
    See entry.

    Attribute creation order
    tracking and indexing
     
    H5Pset_attr_creation_order      herr_t H5Pset_attr_creation_order( hid_t ocpl_id, unsigned crt_order_flags )
    See entry.
    H5Pget_attr_creation_order      herr_t H5Pget_attr_creation_order( hid_t ocpl_id, unsigned *crt_order_flags )
    See entry.
    H5Aget_create_plist      hid_t H5Aget_create_plist( hid_t attr_id )
    See entry.

    Shared object header messages (SOHM)
     
    H5Pset_shared_mesg_index      herr_t H5Pset_shared_mesg_index( hid_t fcpl_id, unsigned index_num, unsigned mesg_type_flags, unsigned min_mesg_size )
    See entry.
    H5Pset_shared_mesg_nindexes      herr_t H5Pset_shared_mesg_nindexes( hid_t plist_id, unsigned nindexes )
    See entry.
    H5Pset_shared_mesg_phase_change      herr_t H5Pset_shared_mesg_phase_change( hid_t fcpl_id, unsigned max_list, unsigned min_btree )
    See entry.
    H5Pget_shared_mesg_index      herr_t H5Pget_shared_mesg_index( hid_t fcpl_id, unsigned index_num, unsigned *mesg_type_flags, unsigned *min_mesg_size )
    See entry.
    H5Pget_shared_mesg_nindexes      herr_t H5Pget_shared_mesg_nindexes( hid_t fcpl_id, unsigned *nindexes )
    See entry.
    H5Pget_shared_mesg_phase_change      herr_t H5Pget_shared_mesg_phase_change( hid_t fcpl_id, unsigned *max_list, unsigned *min_btree )
    See entry.

    Enhanced local heap size
    management   (group meta data)
     
    H5Pset_local_heap_size_hint      herr_t H5Pset_local_heap_size_hint( hid_t gcpl_id, size_t *size_hint )
    See entry.
    H5Pget_local_heap_size_hint      herr_t H5Pget_local_heap_size_hint( hid_t gcpl_id, size_t size_hint )
    See entry.

    UNICODE support
     
    H5Pset_char_encoding      herr_t H5Pset_char_encoding( hid_t plist_id, H5T_cset_t encoding )
    See entry.
    H5Pget_char_encoding      herr_t H5Pget_char_encoding( hid_t plist_id, H5T_cset_t encoding )
    See entry.

    Object API (H5O), all new
     
    H5Oclose      herr_t H5Oclose( hid_t object_id )
    See entry.
    H5Ocopy      herr_t H5Ocopy( hid_t src_loc_id, const char *src_name, hid_t dst_loc_id, const char *dst_name, hid_t ocp_plist_id, hid_t lcpl_id )
    See entry.
    H5Odecr_refcount      herr_t H5Odecr_refcount( hid_t object_id )
    See entry.
    H5Oget_comment      ssize_t H5Oget_comment( hid_t object_id, char *comment, size_t bufsize )
    See entry.
    H5Oget_comment_by_name      ssize_t H5Oget_comment_by_name( hid_t loc_id, const char *name, char *comment, size_t bufsize, hid_t lapl_id )
    See entry.
    H5Oget_info      herr_t H5Oget_info( hid_t object_id, H5O_info_t *obj_info )
    See entry.
    H5Oget_info_by_idx      herr_t H5Oget_info_by_idx( hid_t loc_id, const char *group_name, H5_index_t index_field, H5_iter_order_t order, hsize_t n, H5O_info_t *obj_info, hid_t lapl_id )
    See entry.
    H5Oget_info_by_name      herr_t H5Oget_info_by_name( hid_t loc_id, const char *object_name, H5O_info_t *object_info, hid_t lapl_id )
    See entry.
    H5Oincr_refcount      herr_t H5Oincr_refcount( hid_t object_id )
    See entry.
    H5Olink      herr_t H5Olink( hid_t obj_id, hid_t new_loc_id, const char *new_link_name, hid_t lcpl, hid_t lapl )
    See entry.
    H5Oopen      hid_t H5Oopen( hid_t loc_id, const char *name, hid_t lapl_id )
    See entry.
    H5Oopen_by_addr      hid_t H5Oopen_by_addr( hid_t loc_id, haddr_t addr )
    See entry.
    H5Oopen_by_idx      herr_t H5Oopen_by_idx( hid_t loc_id, const char *group_name, H5_index_t index_field, H5_iter_order_t order, hsize_t n, hid_t lapl_id )
    See entry.
    H5Oset_comment      herr_t H5Oset_comment( hid_t object_id, const char *comment )
    See entry.
    H5Oset_comment_by_name      herr_t H5Oset_comment_by_name( hid_t loc_id, const char *name, const char *comment, hid_t lapl_id )
    See entry.
    H5Ovisit      herr_t H5Ovisit( hid_t group_id, H5_index_t index_type, H5_iter_order_t order, H5O_iterate_t op, void *op_data )
    See entry.
    H5Ovisit_by_name      herr_t H5Ovisit_by_name( hid_t loc_id, const char *object_name, H5_index_t index_type, H5_iter_order_t order, H5O_iterate_t op, void *op_data, hid_t lapl_id )
    See entry.

    Object creation or copying with
    “create intermediate groups” property
     
    H5Pset_create_intermediate_group   herr_t H5Pset_create_intermediate_group( hid_t gcpl_id, unsigned crt_intermed_group )
    See entry.
    H5Pget_create_intermediate_group herr_t H5Pget_create_intermediate_group( hid_t gcpl_id, unsigned *crt_intermed_group )
    See entry.

    Object copy properties
     
    H5Ocopy      herr_t H5Ocopy( hid_t src_loc_id, const char *src_name, hid_t dst_loc_id, const char *dst_name, hid_t ocp_plist_id, hid_t lcpl_id )
    See entry.
    H5Pset_copy_object      herr_t H5Pset_copy_object( hid_t cplist_id, unsigned copy_options )
    See entry.
    H5Pget_copy_object      herr_t H5Pget_copy_object( hid_t cplist_id, unsigned *copy_options )
    See entry.

    Improved object and file
    information retrieval
     
    H5Aget_info      herr_t H5Aget_info( hid_t attr_id, H5A_info_t *ainfo )
    See entry.
    H5Aget_info_by_name      herr_t H5Aget_info_by_name( hid_t loc_id, const char *obj_name, const char *attr_name, H5A_info_t *ainfo, hid_t lapl_id )
    See entry.
    H5Aget_info_by_idx      herr_t H5Aget_info_by_idx( hid_t loc_id, const char *obj_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, H5A_info_t *ainfo, hid_t lapl_id )
    See entry.
    H5Fget_info      herr_t H5Fget_info( hid_t obj_id, H5F_info_t *bh_info )
    See entry.
    H5Gget_info      herr_t H5Gget_info( hid_t group_id, H5G_info_t group_info )
    See entry.
    H5Gget_info_by_name      herr_t H5Gget_info_by_name( hid_t loc_id, const char *group_name, H5G_info_t group_info, hid_t lapl_id )
    See entry.
    H5Gget_info_by_idx      herr_t H5Gget_info_by_idx( hid_t loc_id, const char *group_name, H5_index_t index_type, H5_iter_order_t order, hsize_t n, H5G_info_t group_info, hid_t lapl_id )
    See entry.
    H5Lget_info      herr_t H5Lget_info( hid_t link_loc_id, const char *link_name, H5L_info_t *link_buff, hid_t lapl_id )
    See entry.
    H5Lget_info_by_idx      herr_t H5Lget_info_by_idx( hid_t loc_id, const char *group_name, H5_index_t index_field, H5_iter_order_t order, hsize_t n, H5L_info_t *link_val, hid_t lapl_id )
    See entry.
    H5Oget_info      herr_t H5Oget_info( hid_t object_id, H5O_info_t *obj_info )
    See entry.
    H5Oget_info_by_name      herr_t H5Oget_info_by_name( hid_t loc_id, const char *object_name, H5O_info_t *object_info, hid_t lapl_id )
    See entry.
    H5Oget_info_by_idx      herr_t H5Oget_info_by_idx( hid_t loc_id, const char *group_name, H5_index_t index_field, H5_iter_order_t order, hsize_t n, H5O_info_t *obj_info, hid_t lapl_id )
    See entry.

    Name of referenced object
     
    H5Rget_name      ssize_t H5Rget_name( hid_t loc_id, H5R_type_t ref_type, void *ref, char *name, size_t size )
    See entry.

    Anonymous object creation
     
    H5Dcreate_anon      hid_t H5Dcreate_anon( hid_t loc_id, hid_t type_id, hid_t space_id, hid_t dcpl_id, hid_t dapl_id )
    See entry.
    H5Gcreate_anon      hid_t H5Gcreate_anon(hid_t loc_id, const char * name, hid_t gcpl_id, hid_t gapl_id)
    See entry.
    H5Tcommit_anon      herr_t H5Tcommit_anon( hid_t loc_id, hid_t type_id, hid_t tcpl_id, hid_t tapl_id )
    See entry.
    H5Lcreate_hard      herr_t H5Lcreate_hard( hid_t obj_loc_id, const char *obj_name, hid_t link_loc_id, const char *link_name, hid_t lcpl, hid_t lapl )
    See entry.

    New-style object creation and open
    functions  (includes anonymous
    object creation)
     
    H5Dcreate_anon      hid_t H5Dcreate_anon( hid_t loc_id, hid_t type_id, hid_t space_id, hid_t dcpl_id, hid_t dapl_id )
    See entry.
    H5Dcreate2      hid_t H5Dcreate2( hid_t loc_id, const char *name, hid_t type_id, hid_t space_id, hid_t lcpl_id, hid_t dcpl_id, hid_t dapl_id )
    See entry.
    H5Dopen2      hid_t H5Dopen2( hid_t loc_id, const char *name, hid_t dapl_id )
    See entry.
    H5Gcreate_anon      hid_t H5Gcreate_anon(hid_t loc_id, const char * name, hid_t gcpl_id, hid_t gapl_id)
    See entry.
    H5Gcreate2      hid_t H5Gcreate2( hid_t loc_id, const char *name, hid_t lcpl_id, hid_t gcpl_id, hid_t gapl_id )
    See entry.
    H5Gopen2      hid_t H5Gopen2( hid_t loc_id, const char * name, hid_t gapl_id )
    See entry.
    H5Tcommit_anon      herr_t H5Tcommit_anon( hid_t loc_id, hid_t type_id, hid_t tcpl_id, hid_t tapl_id )
    See entry.
    H5Tcommit2      herr_t H5Tcommit2( hid_t loc_id, const char *name, hid_t type_id, hid_t lcpl_id, hid_t tcpl_id, hid_t tapl_id )
    See entry.
    H5Topen2      hid_t H5Topen2( hid_t loc_id, const char * name, hid_t tapl_id )
    See entry.

    User-defined identifiers
     
    H5Iregister      hid_t H5Iregister(H5I_type_t type, void *object)
    See entry.
    H5Iregister_type      H5I_type_t H5Iregister_type(size_t hash_size, unsigned reserved, H5I_free_t free_func)
    See entry.
    H5Idestroy_type      herr_t H5Idestroy_type(H5I_type_t type)
    See entry.
    H5Iinc_type_ref      int H5Iinc_type_ref(H5I_type_t type)
    See entry.
    H5Idec_type_ref      int H5Idec_type_ref(H5I_type_t type)
    See entry.
    H5Iget_type_ref      int H5Iget_type_ref(H5I_type_t type)
    See entry.

    Other identifier API (H5I) enhancements
     
    H5Iclear_type      herr_t H5Iclear_type(H5I_type_t type, hbool_t force)
    See entry.
    H5Inmembers      int H5Inmembers(H5I_type_t type, hsize_t *num_members)
    See entry.
    H5Iobject_verify      void * H5Iobject_verify(hid_t id, H5I_type_t id_type)
    See entry.
    H5Iremove_verify      void * H5Iremove_verify(hid_t id, H5I_type_t id_type)
    See entry.
    H5Isearch      void * H5Isearch(H5I_type_t type, H5I_search_func_t func, void *key)
    See entry.
    H5Itype_exists      htri_t H5Itype_exists(H5I_type_t type)
    See entry.

    Compression filters: N-bit
    and scale-offset
     
    H5Pset_nbit      herr_t H5Pset_nbit( hid_t plist_id )
    See entry.
    H5Pset_scaleoffset      herr_t H5Pset_scaleoffset( hid_t plist_id, H5Z_SO_scale_type_t scale_type, int scale_factor )
    See entry.

    User-defined datatype conversion
    callback functions
     
    H5Pget_type_conv_cb      herr_t H5Pget_type_conv_cb( hid_t plist, H5T_conv_except_func_t *func, void **op_data )
    See entry.
    H5Pset_type_conv_cb      herr_t H5Pset_type_conv_cb( hid_t plist, H5T_conv_except_func_t func, void *op_data )
    See entry.

    Datatype compiler conversion check
     
    H5Tcompiler_conv      htri_t H5Tcompiler_conv( hid_t src_id, hid_t dst_id )
    See entry.

    Dataset array size reduction
     
    H5Dset_extent      herr_t H5Dset_extent( hid_t dset_id, const hsize_t *size )
    See entry.

    Dataspace equivalence
     
    H5Sextent_equal      herr_t H5Sextent_equal( hid_t sid1, hid_t sid2 )
    See entry.

    Direct I/O, bypassing system cache
     
    H5Pset_fapl_direct      herr_t H5Pset_fapl_direct( hid_t fapl_id, size_t alignment, size_t block_size, size_t cbuf_size )
    See entry.
    H5Pget_fapl_direct      herr_t H5Pget_fapl_direct( hid_t fapl_id, size_t *alignment, size_t *block_size, size_t *cbuf_size )
    See entry.

    Parallel I/O optimization
    (collective chunk I/O)
     
    H5Pset_dxpl_mpio_chunk_opt      herr_t H5Pset_dxpl_mpio_chunk_opt(hid_t dxpl_id, H5FD_mpio_chunk_opt_t opt_mode)
    See entry.
    H5Pset_dxpl_mpio_chunk_opt_num      herr_t H5Pset_dxpl_mpio_chunk_opt_num(hid_t dxpl_id, unsigned num_chunk_per_proc)
    See entry.
    H5Pset_dxpl_mpio_chunk_opt_ratio      herr_t H5Pset_dxpl_mpio_chunk_opt_ratio(hid_t dxpl_id, unsigned percent_num_proc_per_chunk)
    See entry.
    H5Pset_dxpl_mpio_collective_opt      herr_t H5Pset_dxpl_mpio_collective_opt( hid_t dxpl_id, H5FD_mpio_collective_opt_t opt_mode )
    See entry.

    Enhanced error handling (H5E)
     
    H5Eauto_is_v2      herr_t H5Eauto_is_v2( hid_t estack_id, unsigned *is_stack )
    See entry.
    H5Eclear2      herr_t H5Eclear2( hid_t estack_id )
    See entry.
    H5Eclose_msg      herr_t H5Eclose_msg (hid_t mesg_id)
    See entry.
    H5Eclose_stack      herr_t H5Eclose_stack(hid_t estack_id)
    See entry.
    H5Ecreate_msg      hid_t H5Ecreate_msg(hid_t class, H5E_type_t msg_type, const char* mesg)
    See entry.
    H5Eget_auto2      herr_t H5Eget_auto2(hid_t estack_id, H5E_auto2_t * func, void **client_data)
    See entry.
    H5Eget_class_name      ssize_t H5Eget_class_name(hid_t class_id, char* name, size_t size)
    See entry.
    H5Eget_current_stack      hid_t H5Eget_current_stack(void)
    See entry.
    H5Eget_msg      ssize_t H5Eget_msg(hid_t mesg_id, H5E_type_t* mesg_type, char* mesg, size_t size)
    See entry.
    H5Eget_num      ssize_t H5Eget_num(hid_t estack_id)
    See entry.
    H5Epop      herr_t H5Epop(hid_t estack_id, size_t count)
    See entry.
    H5Eprint2      herr_t H5Eprint2(hid_t estack_id, FILE * stream)
    See entry.
    H5Epush2      herr_t H5Epush2(hid_t estack_id, const char *file, const char *func, unsigned line, hid_t class_id, hid_t major_id, hid_t minor_id, const char *msg, ...)
    See entry.
    H5Eregister_class      hid_t H5Eregister_class(const char* cls_name, const char* lib_name, const char* version)
    See entry.
    H5Eset_auto2      herr_t H5Eset_auto2(hid_t estack_id, H5E_auto2_t func, void *client_data)
    See entry.
    H5Eset_current_stack      herr_t H5Eset_current_stack(hid_t estack_id)
    See entry.
    H5Eunregister_class      herr_t H5Eunregister_class(hid_t class_id)
    See entry.
    H5Ewalk2      herr_t H5Ewalk2(hid_t estack_id, H5E_direction_t direction, H5E_walk2_t func, void * client_data)
    See entry.

    Meta data cache management
     
    H5Fget_mdc_config      herr_t H5Fget_mdc_config(hid_t file_id, H5AC_cache_config_t *config_ptr)
    See entry.
    H5Fget_mdc_hit_rate      herr_t H5Fget_mdc_hit_rate(hid_t file_id, double *hit_rate_ptr)
    See entry.
    H5Fget_mdc_size      herr_t H5Fget_mdc_size(hid_t file_id, size_t *max_size_ptr, size_t *min_clean_size_ptr, size_t *cur_size_ptr, int *cur_num_entries_ptr)
    See entry.
    H5Freset_mdc_hit_rate_stats      herr_t H5Freset_mdc_hit_rate_stats(hid_t file_id)
    See entry.
    H5Fset_mdc_config      herr_t H5Fset_mdc_config(hid_t file_id, H5AC_cache_config_t *config_ptr)
    See entry.
    H5Pset_mdc_config      herr_t H5Pset_mdc_config(hid_t plist_id, H5AC_cache_config_t * config_ptr)
    See entry.
    H5Pget_mdc_config      herr_t H5Pget_mdc_config(hid_t plist_id, H5AC_cache_config_t * config_ptr)
    See entry.

    File read/write status
     
    H5Fget_intent      herr_t H5Fget_intent( hid_t file_id, unsigned *intent )
    See entry.

    Arithmetic data transform on I/O
     
    H5Pget_data_transform      herr_t H5Pget_data_transform( hid_t plist_id, char* expression, size_t size)
    See entry.
    H5Pset_data_transform      herr_t H5Pset_data_transform( hid_t plist, const char* expression )
    See entry.

    Dataspace and datatype serial conversion
     
    H5Sdecode      hid_t H5Sdecode( const void *buf )
    See entry.
    H5Sencode      herr_t H5Sencode( hid_t obj_id, void *buf, size_t *nalloc )
    See entry.
    H5Tdecode      hid_t H5Tdecode( const void *buf )
    See entry.
    H5Tencode      herr_t H5Tencode( hid_t obj_id, void *buf, size_t *nalloc )
    See entry.

    Enhanced filter management
     
    H5Pget_filter2 herr_t H5Pget_filter2( hid_t plist_id, unsigned idx, unsigned int *flags, size_t *cd_nelmts, unsigned cd_values[], size_t namelen, char name[], unsigned *filter_config)
    See entry.
    H5Pget_filter_by_id2 hid_t H5Pget_filter_by_id2( hid_t plist_id, H5Z_filter_t filter_id, unsigned int *flags, size_t *cd_nelmts, unsigned int cd_values[], size_t namelen, char name[], unsigned int *filter_config)
    See entry.

    Comparison of properties
     
    H5Pinsert2 hid_t H5Pinsert2( hid_t plid, const char *name, size_t size, void *value, H5P_prp_set_func_t set, H5P_prp_get_func_t get, H5P_prp_delete_func_t delete, H5P_prp_copy_func_t copy, H5P_prp_compare_func_t compare, H5P_prp_close_func_t close)
    See entry.
    H5Pregister2 herr_t H5Pregister2( hid_t class, const char * name, size_t size, void * default, H5P_prp_create_func_t create, H5P_prp_set_func_t set, H5P_prp_get_func_t get, H5P_prp_delete_func_t delete, H5P_prp_copy_func_t copy, H5P_prp_compare_func_t compare, H5P_prp_close_func_t close)
    See entry.

    Two-way conversion between datatype
    and text description of datatype
     
    H5LTtext_to_dtype hid_t H5LTtext_to_datatype( const char *text, H5LT_lang_t lang_type)
    See entry.
    H5LTdtype_to_text herr_t H5LTdtype_to_text( hid_t datatype, char *str, H5LT_lang_t lang_type, size_t *len)
    See entry.

    Fortran subroutines:
    New Fortran subroutines in the main library are not yet included for Release 1.8.0-beta.

    See below for Fortran routines for High-Level HDF5 APIs.

    C++ wrappers:
    There no new C++ wrappers for Release 1.8.0-beta.

    High Level C APIs:

    H5LT: The following functions have been added to the HDF5 Lite (H5LT) API:
    H5LTtext_to_dtype hid_t H5LTtext_to_datatype( const char *text, H5LT_lang_t lang_type)
    See entry.
    H5LTdtype_to_text herr_t H5LTdtype_to_text( hid_t datatype, char *str, H5LT_lang_t lang_type, size_t *len)
    See entry.
    H5LTset_attribute_long_long herr_t H5LTset_attribute_long_long( hid_t loc_id, const char *obj_name, const char *attr_name, const long_long *data, size_t *size)
    See entry.
    H5LTget_attribute_long_long     herr_t H5LTget_attribute_long_long( hid_t loc_id, const char *obj_name, const char *attr_name, long_long *data)
    See entry.

    Two high-level C APIs are distributed for the first time with this release:
     
    • H5PT, the HDF5 Packet Table interface
    • H5DS, the HDF5 Dimension Scale interface

    Full documentation for these interfaces can be accessed directly from the High Level APIs overview page.

    The new functions included in the packet table (H5PT) high-level APIs are as follows:
    H5PTcreate_fl hid_t H5PTcreate_fl( hid_t loc_id, const char * dset_name, hid_t dtype_id, hsize_t chunk_size )
    H5PTcreate_vl hid_t H5PTcreate_vl( hid_t loc_id, const char *dset_name, hsize_t chunk_size )
    H5PTopen hid_t H5PTopen( hid_t loc_id, const char *dset_name )
    H5PTclose herr_t H5PTclose( hid_t table_id )
    H5PTappend herr_t H5PTappend( hid_t table_id, hsize_t nrecords, const void *data)
    H5PTcreate_index herr_t H5PTcreate_index( hid_t table_id)
    H5PTset_index herr_t H5PTset_index( hid_t table_id, hsize_t pt_index)
    H5PTread_packets herr_t H5PTread_packets( hid_t table_id, hsize_t start, hsize_t nrecords, void *data)
    H5PTget_next herr_t H5PTget_next( hid_t table_id, hsize_t nrecords, void *data)
    H5PTget_num_packets herr_t H5PTget_num_packets( hid_t table_id, hsize_t * nrecords)
    H5PTis_valid herr_t H5PTis_valid( hid_t table_id)
    H5PTis_varlen herr_t H5PTis_varlen( hid_t table_id)
    H5PTfree_vlen_readbuff     herr_t H5PTfree_vlen_readbuff( hid_t table_id, hsize_t bufflen, void * buff)
     

    The new functions included in the dimension scale (H5DS) high-level APIs are as follows:
    H5DSset_scale herr_t H5DSmake_scale(hid_t dsid, char *dimname)
    H5DSattach_scale herr_t H5DSattach_scale(hid_t did, hid_t dsid, unsigned int idx)
    H5DSdetach_scale herr_t H5DSdetach_scale(hid_t did, hid_t dsid, unsigned int idx)
    H5DSis_attached htri_t H5DSis_attached(hid_t did, hid_t dsid, unsigned int idx)
    H5DSis_scale htri_t H5DSis_scale(hid_t did)
    H5DSiterate_scales herr_t H5DSiterate_scales(hid_t did, unsigned dim, int *idx, H5DS_iterate_t visitor, void *visitor_data)
    H5DSset_label herr_t H5DSset_label(hid_t did, unsigned int idx, const char *label)
    H5DSget_label ssize_t H5DSget_label(hid_t did, unsigned int idx, char *label, size_t size)
    H5DSget_scale_name     hssize_t H5DSget_scale_name(hid_t did, char name, size_t *size)
    H5DSget_num_scales int H5DSget_num_scales(hid_t did, unsigned int idx)

    High Level Fortan90 APIs:
    Fortran90 subroutines are now available for the following high-level APIs:
         H5LT: HDF5 Lite
         H5IM: HDF5 Image
         H5TB: HDF5 Table

    Tools:
    h5stat

    Deprecated and Deleted Functions

    The following functions, subroutines and wrappers have been removed in this release:
    C functions:
     
    H5Pset_fapl_gass
    H5Pget_fapl_gass
     
           HDF5 no longer provides GASS support.
    H5Pset_fapl_srb
    H5Pget_fapl_srb
     
     
           HDF5 no longer provides SRB support.
    SRB functionality is now supported through the mechanism described in SRB — The DICE Storage Resource Broker (http://www.sdsc.edu/srb/index.php/Main_Page).
    H5Pset_fapl_stream
    H5Pget_fapl_stream
     
           The stream virtual file driver (H5FD_STREAM) has been removed from the HDF5 distribution. The functionality was last available from http://hdf5-addons.origo.ethz.ch/.
    H5Tset_overflow
    H5Tget_overflow
           These two functions are replaced by H5Pget_type_conv_cb and H5Pset_type_conv_cb.

    Several functions, subroutines, and wrappers are deprecated in this HDF5 release and may eventually be removed from the HDF5 distribution and from the HDF5 Reference Manual. A Release 1.6.x compatibility mode is provided enabling these and other Release 1.6.x compatibility features, but is available only if the HDF5 Library is configured with the default settings or with the flag --with-default-api-version=v16. Release 1.8.0 also provides macros that can be mapped selectively to 1.6.x and 1.8.0 function versions according to the needs of a user application. The backward compatibility mode is enabled in the Release 1.8.0 binaries distributed by NCSA. See API Compatibility Macros in HDF5 for full details.
     
    Deprecated functions are marked in the function index at the beginning of each API section in the HDF5 Reference Manual.

    Virtual File Driver Removed

    The stream virtual file driver (H5FD_STREAM) have been removed in this release. This affects the functions H5Pset_fapl_stream and H5Pget_fapl_stream and the constant H5FD_STREAM.

    This virtual file driver will remain available at http://hdf5-addons.origo.ethz.ch/. Note that as of this writing, this transition is still in progress; the necessary integration tools may not be available when HDF5 Release 1.8.0 first comes out.

    Functions with New or Changed Symbols or Fixed Values

    Symbols and preset values associated with the following functions, subroutines or wrappers have changed as noted.

    C functions:

    H5Tregister
    Null is no longer a valid value for the parameter func.
     
    H5Pget_filter_by_id
    H5Pmodify_filter
    H5Premove_filter
    H5Pset_filter
    H5Zfilter_avail
    H5Zget_filter_info
    Two new filter identifiers are available for the filter parameter:
        H5Z_FILTER_NBIT
        H5Z_FILTER_SCALEOFFSET
     
    H5Pget_filter
    Two new filter identifiers are available as the return value:
        H5Z_FILTER_NBIT
        H5Z_FILTER_SCALEOFFSET
     

    Fortran90 subroutines:

    h5pget_filter_f
    h5pget_filter_by_id_f
    h5pmodify_filter_f
    h5premove_filter_f
    h5pset_filter_f
    h5zfilter_avail_f
    h5zget_filter_info_f
    Two new filter identifiers are available for the filter or filter_id parameters:
        H5Z_FILTER_NBIT_F
        H5Z_FILTER_SCALEOFFSET_F
     

    Functions with Changed Syntax

    Function syntax changes in this release are handled through the mechanism described in API Compatibility Macros in HDF5.

    Exceptions:
    • The function H5Eget_minor is not governed by the above-mentioned macros and its return type has changed:
      H5Eget_minor
      char *H5Eget_minor (H5E_minor_t n)
      See entry.
      An application calling H5Eget_minor from an HDF5 Library of Release 1.8.0 or later will have to free the memory associated with the return value to prevent a memory leak.
      (This note added at Release 1.8.4, November 2009.)

       

    • In the function H5Dextend, the size parameter signature was changed.
      H5Dextend
      herr_t *H5Dextend( hid_t dataset_id, const hsize_t size[] )
      See entry for current information; see the Release 1.6 entry for the old signature.
      The new function signature is generally considered equivalent to the old signature, but some compilers require an exact match.
      (This note added in February 2010, following Release 1.8.4.)

    Renamed Functions

    The following C functions have been renamed. The original function names remain available under certain circumstances; see API Compatibility Macros in HDF5 for full details.

    Original name New name
    H5Acreate H5Acreate1
    H5Aiterate
     
    H5Aiterate1
     
    H5Eclear H5Eclear1
    H5Eget_auto H5Eget_auto1
    H5Eprint H5Eprint1
    H5Epush H5Epush1
    H5Eset_auto H5Eset_auto1
    H5Ewalk
     
    H5Ewalk1
     
    H5Gcreate H5Gcreate1
    H5Gopen
     
    H5Gopen1
     
    H5Pget_filter H5Pget_filter1
    H5Pget_filter_by_id     H5Pget_filter_by_id1
    H5Pinsert H5Pinsert1
    H5Pregister
     
    H5Pregister1
     
    H5Rget_obj_type
     
    H5Rget_obj_type1
     
    H5Tarray_create H5Tarray_create1
    H5Tcommit H5Tcommit1
    H5Tget_array_ndims H5Tget_array_ndims1
    H5Topen H5Topen1

    Changed Library Structures

    The following library structures have changed as follows:

    C API:

    H5FD_t
    In this struct, the field fileno[2] has changed to fileno.
    The struct is otherwise unchanged.
     
    H5Z_class_t
    This struct contains three new fields:
        version
        encoder_present
        decoder_present
    The struct is now defined as follows:
        typedef struct H5Z_class_t {
            int version; 
            H5Z_filter_t filter_id;
            unsigned encoder_present
            unsigned decoder_present
            const char  *comment;
            H5Z_can_apply_func_t can_apply_func;
            H5Z_set_local_func_t set_local_func;
            H5Z_func_t filter_func;            
        } H5Z_class_t;
    

    Changed ENUMs

    The following enumerated datatypes used by the library are discontinued in this release:

    H5E_major_t — Major error numbers
    H5E_minor_t — Minor error numbers
    HDF5 error codes have changed from the ENUM format used in earlier releases to an identifier format. As ENUMs, error codes were constants defined at compile time; as identifiers, error codes are defined at runtime, in the same manner as HDF5 object identifiers (file, dataset, group, etc.).

    Under normal circumstances, this change should be transparent to user applications.

    The following enumerated datatypes used by the library have changed in the C and Fortran APIs as follows:

    H5G_obj_t — Object types
    This ENUM has reordered as follows:
        H5G_GROUP
        H5G_DATASET
        H5G_TYPE
        H5G_LINK
     
    H5I_type_t — Identifier types
    The following symbols have been added to this ENUM:
        H5I_UNINT
        H5I_ERROR_CLASS
        H5I_ERROR_MSG
        H5I_ERROR_STACK
     
    Another new symbol
        H5I_NTYPES
    replaces the old symbol
        H5I_NGROUPS
    While visible in the public API, H5I_NTYPES functions as a limit value for the HDF5 Library and is not generally used at the application level. The same was true of H5I_NGROUPS.
     
    H5S_class_t — Dataspace type identifiers
    The following symbol has been added:
        H5S_NULL
     
    H5T_cset_t — Character set encoding identifiers
    The following symbol has been added:
        H5T_CSET_UTF8
     
    H5Z_filter_t — Filters identifiers
    The following symbols have been added:
        H5Z_FILTER_NBIT
        H5Z_FILTER_SCALEOFFSET
     

    New Datatypes

    The following OpenVMS-specific floating point datatypes are new with this release:
    H5T_VAX_F32
    H5T_VAX_F64

    New Property Lists

    The following property lists are new with this release:
    H5P_DATASET_ACCESS
    H5P_GROUP_CREATE
    H5P_GROUP_ACCESS
    H5P_DATATYPE_CREATE
    H5P_DATATYPE_ACCESS
    H5P_ATTRIBUTE_CREATE

    Changed Library Configuration

    The following configuration features have changed as follows.
    • New with this release:
          --disable-dependency-tracking
          
          --enable-hdf5v1_6
          
          --enable-dconv-exception
          --disable-dconv-exception
          --enable-dconv-accuracy
          --disable-dconv-accuracy
          
          --program-prefix=PREFIX
          --program-prefix=SUFFIX
          --program-transform-name=PROGRAM
          
          --enable-maintainer-mode
          
          --disable-dependency-tracking
          --enable-dependency-tracking
          
          --enable-codestack
          
          --enable-direct-vfd
          
          --with-tags[=TAGS]
          
    • New with this release, but expected to be useful only to those working inside the HDF5 Library or working very closely with HDF5 developers:
          --enable-build-all
          --enable-metadata-trace-file
          
    • New with this release, but not actively supported:
          --enable-fphdf5
          
    • Changed in this release:
          --enable-shared[=PKGS]
          --enable-static[=PKGS]
          --enable-fast-install[=PKGS]
          
    • Removed in this release:
          --enable-hdf5v1_4
          --enable-funcstack
          --with-ssl=LIB
          --with-gass=DIR
          --with-srb=DIR

    The environment variables FC and FCFLAGS replace F9X and F9XFLAGS, respectively, which are deprecated in this release.

    Additional new “influential environment variables” in this release include the following:
        CXX
        CXXFLAGS
        CXXCPP
        F77
        FFLAGS

     

    Release 1.6.10 versus Release 1.6.9, November 2009

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

    Embedded HDF5 Library Settings Information

    Library settings are now embedded in an HDF5 executable so that an “orphaned” executable can be queried (via the Unix strings command, for example) to display the library settings used to build it. The embedded settings information is the same as that normally found in the libhdf5.settings file.

    This capability may be disabled with the use of the --disable-embedded-libin flag during configure.

    Function with Changed Interface or Behavior

    H5check_version now displays embedded library information (see above) if a version mismatch is detected.

    The function has also been changed to suppress the warning message entirely if $HDF5_DISABLE_VERSION_CHECK is set to 2 or higher.

    New C++ Member Function

    New C++ member functions are provided to determine a dataset’s or attribute’s data size in memory:

       size_t DataSet::getInMemDataSize() const
       size_t Attribute::getInMemDataSize() const

    The size in each case is in bytes.

    Tool with Changed Interface or Behavior

    h5diff has one new option:

        --use-system-epsilon

    With this option, h5diff returns a difference if and only if the difference between two data values exceeds the system value for epsilon (that is, if |a-b| > epsilon).

    The tool’s default behavior has also changed; without this option, the tool now checks for strict equality.

    This option has no short form.

    Release 1.6.9 versus Release 1.6.8, May 2009

    This section lists API-level changes and changes in behavior in the transition from HDF5 Release 1.6.8 to Release 1.6.9.

    API Compatibility Macros

    To facilitate writing applications that work with both the HDF5 Release 1.6 series and the 1.8 series, API compatibility macros analogous to those in 1.8 have been defined. These macros map directly to the relevant functions and typedefs. Note that only the 1.6-style macros are supported in this branch.

    Any program that is written using these macros exculsively will work with both the 1.6 and 1.8 series HDF5 Libraries. The program will work without having to use any special flags or definitions, as long as the 1.8 library was compiled with support for deprecated symbols, which is the default.

    Following is a list of macros and the symbols they alias:

    Macro Symbol
    H5Acreate1 H5Acreate
    H5Aiterate1 H5Aiterate
    H5A_operator1_t H5A_operator_t
    H5Dcreate1 H5Dcreate
    H5Dopen1 H5Dopen
    H5Eclear1 H5Eclear
    H5Eget_auto1 H5Eget_auto
    H5Eprint1 H5Eprint
    H5Epush1 H5Epush
    H5Eset_auto1 H5Eset_auto
    H5Ewalk1 H5Ewalk
    H5E_walk1_t H5E_walk_t
    H5E_error1_t H5E_error_t
    H5Gcreate1 H5Gcreate
    H5Gopen1 H5Gopen
    H5Pget_filter1 H5Pget_filter
    H5Pget_filter_by_id1 H5Pget_filter_by_id
    H5Pinsert1 H5Pinsert
    H5Pregister1 H5Pregister
    H5Rget_obj_type1 H5Rget_obj_type
    H5Tarray_create1 H5Tarray_create
    H5Tcommit1 H5Tcommit
    H5Tget_array_dims1 H5Tget_array_dims
    H5Topen1 H5Topen
    H5E_auto1_t H5E_auto_t
    H5Z_class1_t H5Z_class_t

    Note that for the 1.6 series, the numbered symbols are macros, while in the 1.8 series, the non-numbered symbols are macros. This was done because there is no need to switch between different API versions in the 1.6 series.

    H5Z_class1_t was introduced in Release 1.6.9 while all the others were introduced in Release 1.6.8. For more information see API Compatibility Macros, an HDF5 Release 1.8-series document.

    Tools with Changed Interface or Behavior

    h5diff
    The default behavior of h5diff is now to detect and compare NaNs. Use the -N or --nan option (below) to turn this behavior off and avoid the performance penalty that NaN detection and comparison entalis. (NaN detection and comparison became the default in in HDF5 Release 1.6.8.)

    This tool has two new options:

         -c, --compare      Lists objects that are not comparable.

         -N, --nan          Avoids NaNs detection.

    h5dump
    h5dump now correctly specifies an XML DTD or a schema URL.

    h5dump binary output now defaults to NATIVE.

    The new -b, --binary option can be used to specify alternate binary formats.

    h5repack
    When a user does not specify a chunk size, h5repack now defines the default chunk size to be the same same as the size of the hyperslab used to read the chunks.

    Release 1.6.8 versus Release 1.6.7, November 2008

    This section lists API-level changes and changes in behavior in the transition from HDF5 Release 1.6.7 to Release 1.6.8.

    Functions with Changed Syntax

    The following function syntaxes have changed; the affected return values and parameter are noted as underscored red text.

    C function:
    H5Fget_obj_count
    ssize_t H5Fget_obj_count( hid_t file_id, unsigned int types )

    H5Fget_obj_ids
    ssize_t H5Fget_obj_ids( hid_t file_id, unsigned int types,
            size_t max_objs, hid_t *obj_id_list )

    Tools with Changed Interface or Behavior

    h5repack and h5diff
    The standard command-line syntax of both tools has been changed to parallel that of h5dump. The new syntax of each is as follows:

         h5repack [OPTIONS] file1 file2

         h5diff [OPTIONS] file1 file2 [object1 [object2]]

    In each case, the old syntax remains available (though undocumented) to avoid breaking existing scripts.

    h5diff
    h5diff now returns 1 if the files differ in structure, i.e., if the file graphs differ by any object.

    The tool’s error return code has been changed to 2.

    h5repack
    The following new options control the addition of user block data to an existing HDF5 file:
    -u U
    --ublock=U
         Specifies the name of the file containing the user block data to be added.

    -b B
    --block=B
        
    Specifies the size of the block to be added.

    The following new options set parameters governing the tool’s use of H5Pset_alignment:
    -t T
    --threshold=T
         Specifies the threshold value for H5Pset_alignment.

    -a A
    --alignment=A
        
    Specifies the alignment value for H5Pset_alignment.

    h5repack now supports multiple instances of the '-f' or '--filter' option, allowing the use of multiple I/O filters with an object.

    With no change in the command-line syntax, h5repack now retains an existing userblock when repacking an HDF5 file.

    h5import
    The floating point format flag TEXTFPE, for scientific notation, has been deprecated. The flag TEXTFP, which accepts scientific notation, should be used instead.

    h5import now imports string data with the STR keyword in the INPUT-CLASS configuration field.

    h5dump
    The new '-m T' or '--format T' option enables a user-defined formatting string for printing floating-point numbers.

    With no change in the command-line syntax, h5dump now prints a compression ratio when compression filters are in use.

    Deprecated Functions

    The following functions are deprecated as of this release:
            H5Pset_preserve
            H5Pget_preserve 

    The original role of these functions is now part of the core HDF5 Library functionality.

    Changed File Installation

    The file libhdf5_fortran.settings is no longer installed with the HDF5 Library; the original content of that file is now included in libhdf5.settings.

    Release 1.6.7 versus Release 1.6.6

    This section lists the API-level changes that have been made in the transition from the HDF5 Release 1.6.6 to Release 1.6.7. As this is primarily a bug-fix release, the only interface changes are one changed function signature and the changes related to the removal of the stream I/O driver, as outlined below.

    Function with Changed Syntax

    The following function syntax has changed; the affected parameter is noted in red.

    C function:
    H5Sselect_elements
    herr_t H5Sselect_elements( hid_t space_id, H5S_seloper_t op,
            size_t num_elements, const hsize_t *coord )

    (This syntax change was listed on 10 September 2008, several months after Release 1.6.7.)

    Stream I/O Driver Removed

    The stream I/O driver, H5FD_STREAM, has been removd from and is no longer distributed with the HDF5 Library. The following APIs have therefore been removed from this release.
        H5Pset_fapl_stream
        H5Pget_fapl_stream
    The stream driver ENUM value H5FD_STREAM has also been removed.

    While the stream driver is no longer distributed by The HDF Group, it will be made available as a source code distribution from http://hdf5-addons.origo.ethz.ch/. An integration mechanism will be developed and instructions for using the driver with HDF5 will be posted on that site.

    Release 1.6.6 versus Release 1.6.5

    This section lists the API-level changes that have been made in the transition from the HDF5 Release 1.6.5 to Release 1.6.6.

    Release 1.6.6 is primarily a bug-fix release and includes no changes in the syntax or intended behavior of the library’s public interfaces. There are, however, two changes in tool interfaces.

    Tools with Changed Options and/or Behavior

    The following tools have changed in this release; these changes are documented on the Tools page of the HDF5 Reference Manual.
     
    h5repack:
    A new -n option allows the user to specify that a new file created by h5repack will use native datatypes. The default behavior is to use the original file datatypes.
         -n   Use native HDF5 datatypes when repacking.
    (Default behavior is to use the original file datatypes.)
    Note that the default behavior of this tool has changed; prior to Release 1.6.6, h5repack generated files only with native datatypes.

    h5dump:
    This tool includes a new -b option for binary output.
         -b B   or
    --binary=B   
    Output dataset to a binary file using the datatype specified by B.
    B must have one of the following values:
         LE        Little-endian
         BE        Big-endian
         MEMORY    Memory datatype
         FILE      File datatype
    Recommended usage is with the -d and -o options.

     

    Release 1.6.5 versus Release 1.6.4

    This section lists the API-level changes that have been made in the transition from the HDF5 Release 1.6.4 to Release 1.6.5.

    New Functions and Tools

    C functions and
    Fortran subroutines:
    HDF5 Release 1.6.5 is primarily a maintenance release, focusing on bugfixes, optimization and portability; there are no new C APIs or Fortran subroutines.
     
    High Level C APIs:
    The High Level C APIs (HL), including the HDF5 Image, HDF5 Table, and HDF5 Lite interfaces (H5IM, H5TB, and H5LT, respectively), have been distributed with the main HDF5 source code distribution since Release 1.6.4 and are documented in HDF5: High Level APIs. (Note: In release 1.8 and later, the HL APIs are documented in the HDF5 Reference Manual.)
     
    C++ wrappers:
    void PropList::copyProp(PropList& dest, const char* name) const
    void PropList::copyProp(PropList& dest, const string& name) const
    string CommonFG::getComment(const string& name) const
    void CommonFG::removeComment(const char* name) const
    void CommonFG::removeComment(const string& name) const
    hsize_t Attribute::getStorageSize() const
    void Attribute::close()
    void DataSet::close()
    void DataSpace::close()
    void DataType::close()
    void H5File::close()
    void Group::close()
    void PropList::close()
    H5T_order_t AtomType::getOrder() const
    void H5Object::renameAttr(const char* oldname, const char* newname) const
    void H5Object::renameAttr(const string& oldname, const string& newname) const
    string CommonFG::getObjnameByIdx(hsize_t idx) const
    ArrayType AbstractDs::getArrayType() const
    VarLenType AbstractDs::getVarLenType() const
    ArrayType CommonFG::openArrayType(const char* name) const
    ArrayType CommonFG::openArrayType(const string& name) const
    VarLenType CommonFG::openVarLenType(const char* name) const
    VarLenType CommonFG::openVarLenType(const string& name) const
    ArrayType CompType::getMemberArrayType(unsigned member_num) const
    VarLenType CompType::getMemberVarLenType(unsigned member_num) const
     

    Functions with New or Changed Symbols or Fixed Values

    Symbols and preset values associated with the following functions have changed as noted.

    C functions:
    H5Fget_obj_count
    H5F_OBJ_LOCAL has been added as a qualifier on the types of objects to be counted. H5F_OBJ_LOCAL restricts the search to objects opened through current file identifier.
    H5Tset_tag
    The H5T_OPAQUE_TAG_MAX macro constant, specifying the maximum size of an opaque datatype tag, was added in H5Tpublic.h.

    Functions with Changed Syntax

    The following functions have changed as noted. Changed items are indicated in red.

    C++ wrappers:
    In all cases below, a parameter datatype has changed from int to unsigned.
    string CompType::getMemberName( unsigned member_num ) const
    size_t CompType::getMemberOffset( unsigned member_num ) const
    int CompType::getMemberDims( unsigned member_num, size_t* dims, int* perm ) const
    H5T_class_t CompType::getMemberClass( unsigned member_num ) const
    hid_t CompType::p_get_member_type( unsigned member_num) const
    DataType CompType::getMemberDataType( unsigned member_num ) const
    ArrayType CompType::getMemberArrayType( unsigned member_num ) const
    CompType CompType::getMemberCompType( unsigned member_num ) const
    EnumType CompType::getMemberEnumType( unsigned member_num ) const
    IntType CompType::getMemberIntType( unsigned member_num ) const
    FloatType CompType::getMemberFloatType( unsigned member_num ) const
    StrType CompType::getMemberStrType( unsigned member_num ) const
    VarLenType CompType::getMemberVarLenType( unsigned member_num ) const

    Changed Library Configuration

     

    Release 1.6.4 versus Release 1.6.3

    This section lists the API-level changes that have been made in the transition from the HDF5 Release 1.6.3 to Release 1.6.4.

    New Functions and Tools

    C functions and
    Fortran subroutines:
    HDF5 Release 1.6.4 "Bugfix Release"; there are no new C APIs or Fortran subroutines.
     
    High Level C APIs:
    The High Level C APIs (HL), including the HDF5 Image, HDF5 Table, and HDF5 Lite interfaces (H5IM, H5TB, and H5LT, respectively) , have been brought into the main HDF5 source code distribution. A link to the HL documentation appears on the opening page of the HDF5 document set or can be accessed directly at http://www.hdfgroup.org/HDF5/hdf5_hl/doc/RM_hdf5hl.html

    The HL library, libhdf5_hl.a(so), is built and installed by default but can be disabled with the --disable-hl configure flag.
     
    Tools:
    A new pair of tools, h5jam and h5unjam, is available to manage user blocks in HDF5 files. See their entry in the HDF5 Reference Manual.

    Deleted Functions

    The following functions have been removed in this release.
     
    C++ wrappers:
    The C++ wrappers now rely on the C library's reference counting in place of the class RefCounter, which existed before the C mechanism was available. RefCounter has therefore been removed.

    Functions with Changed Syntax

    The following functions have changed as noted. In general, one or more parameters or the return value has changed from a signed to an unsigned datatype. Changed items are indicated in red.

    C functions:
    H5Pget_version
    herr_t H5Pget_version(hid_t plist_id, unsigned *boot/*out*/,
    unsigned *freelist/*out*/, unsigned *stab/*out*/, unsigned *shhdr/*out*/)
    H5Pset_sym_k
    H5Pset_sym_k(hid_t plist_id, unsigned ik, unsigned lk)
    H5Pget_sym_k
    H5Pget_sym_k(hid_t plist_id, unsigned *ik/*out*/, unsigned *lk/*out*/)
    H5Pset_istore_k
    herr_t H5Pset_istore_k(hid_t plist_id, unsigned ik)
    H5Pget_istore_k
    herr_t H5Pget_istore_k(hid_t plist_id, unsigned *ik/*out*/)
    H5Pget_external
    herr_t H5Pget_external(hid_t plist_id, unsigned idx, size_t name_size,
    char *name/*out*/, off_t *offset/*out*/, hsize_t *size/*out*/)
    H5Pget_filter
    H5Z_filter_t H5Pget_filter(hid_t plist_id, unsigned filter,
    unsigned int *flags/*out*/, size_t *cd_nelmts/*out*/,
    unsigned cd_values[]/*out*/, unsigned int *flags/*out*/,
    size_t namelen, char name[])
    H5Sselect_hyperslab
    herr_t H5Sselect_hyperslab(hid_t space_id, H5S_seloper_t op,
    const hsize_t start[], const hsize_t _stride[], const hsize_t count[],
    const hsize_t _block[])
    H5Sselect_elements
    herr_t H5Sselect_elements(hid_t space_id, H5S_seloper_t op,
    size_t num_elemn, const hsize_t **coord)
    H5Tget_member_name
    char *H5Tget_member_name(hid_t type_id, unsigned membno)
    H5Tget_member_offset
    size_t H5Tget_member_offset(hid_t type_id, unsigned membno)
    H5Tget_member_class
    H5T_class_t H5Tget_member_class(hid_t type_id, unsigned membno)
    H5Tget_member_type
    hid_t H5Tget_member_type(hid_t type_id, unsigned membno)
    H5Tget_member_value
    herr_t H5Tget_member_value(hid_t type_id, unsigned membno,
    void *value/*out*/)

    H5Diterate is affected by a similar change in the syntax of H5D_operator_t.
    herr_t (*H5D_operator_t)(void *elem, hid_t type_id, unsigned ndim,
    const hsize_t *point, void *operator_data)

    Fortran subroutines:
    h5sselect_hyperslab_f
    SUBROUTINE h5sselect_hyperslab_f(space_id, operator, start, count, &
    hdferr, stride, block)
    h5sselect_elements_f
    SUBROUTINE h5sselect_elements_f(space_id, operator, rank, &
    num_elements, coord, hdferr)

    C++ wrappers:
    FileCreatPropList::getVersion
    void FileCreatPropList::getVersion( unsigned& super, unsigned& freelist,
    unsigned& stab, unsigned& shhdr) const
    FileCreatPropList::setSymk
    void FileCreatPropList::setSymk( unsigned ik, unsigned lk ) const
    FileCreatPropList::getSymk
    void FileCreatPropList::getSymk( unsigned& ik, unsigned& lk ) const
    FileCreatPropList::setIstorek
    void FileCreatPropList::setIstorek( unsigned ik ) const
    FileCreatPropList::getIstorek
    unsigned FileCreatPropList::getIstorek() const
    DSetCreatPropList::getExternal
    void DSetCreatPropList::getExternal( unsigned idx, size_t name_size,
    char* name, off_t& offset, hsize_t& size ) const
    DSetCreatPropList::getFilter
    H5Z_filter_t DSetCreatPropList::getFilter( ine filter_number,
    unsigned int &flags, size_t &cd_nelmts, unsigned int* cd_values,
    size_t namelen, char name[] ) const
    DataSpace::selectHyperslab
    void DataSpace::selectHyperslab( H5S_seloper_t op, const hsize_t *count,
    const hsize_t *start, const hsize_t *stride, const hsize_t *block ) const
    DataSpace::selectElements
    void DataSpace::selectElements( H5S_seloper_t op,
    const size_t num_elements, const hsize_t *coord[ ] ) const
    CompType::getMemberName
    string CompType::getMemberName( unsigned member_num ) const
    CompType::getMemberOffset
    size_t CompType::getMemberOffset( unsigned member_num ) const
    CompType::getMemberClass
    H5T_class_t CompType::getMemberClass( unsigned member_num ) const
    EnumType::getMemberValue
    void EnumType::getMemberValue( unsigned member_no, void *value ) const

    (These lists of syntax changes were added on 31 March and 5 April 2005, shortly after Release 1.6.4.)

    Deleted Constants

    The following constants have been removed from the HDF5 Library: (This list of deleted constants was added on 21 March 2005, shortly after Release 1.6.4.)

    Changed Library Configuration

    HDF5 Library configuration has been upgraded from GNU autoconf 2.53 to autoconf 2.59.

     

    Release 1.6.3 versus Release 1.6.2

    This section lists the API-level changes that have been made in the transition from the HDF5 Release 1.6.2 to Release 1.6.3.

    New Functions and Tools

    C functions:
    The following C functions are new for Release 1.6.3 and are documented in the HDF5 Reference Manual.
    H5Fget_name      ssize_t H5Fget_name (hid_t obj_id, char *name, size_t size)
    See entry.
    H5Fget_filesize      herr_t H5Fget_filesize (hid_t file_id, hsize_t * size)
    See entry.
    H5Iget_file_id      hid_t H5Iget_file_id (hid_t obj_id)
    See entry.
    H5Premove_filter      herr_t H5Premove_filter (hid_t obj_id, H5Z_filter_t filter)
    See entry.
    H5Zget_filter_info      herr_t H5Zget_filter_info (H5Z_filter_t filter, unsigned int * flags)
    See entry.
     
    Fortran subroutines:
    The following Fortran90 subroutines are new for Release 1.6.3 and are documented in the HDF5 Reference Manual.
    New Fortran90 subroutines corresponding to the new C functions listed above:
        h5fget_name_f
        h5fget_filesize_f
        h5iget_file_id_f
        h5premove_filter_f
        h5zget_filter_info_f
    New Fortran90 subroutines corresponding to C functions from prior releases:
        None
        
     
    C++ wrappers:
    C++ wrappers have been brought in sync with the C library, rendering the C++ API significantly more complete. Most of the new wrappers are for H5P and H5T APIs.

    All available C++ elements are now documented in the HDF5 C++ API Reference Manual. (The HDF5 C++ API Reference Manual is also a new addition in this release.)

     
    Tools:
    The following tools are new for Release 1.6.3 and are documented on the Tools page of the HDF5 Reference Manual.
    h5new_tool is designed to do whatever this sentence says. (Clearly, this is a placeholder entry that should be removed before release.)
     
    The following tool was in Release 1.6.2 but was not included in formal documentation. A full description is now included on the Tools page of the HDF5 Reference Manual.
    h5repack is designed to copy an HDF5 file to a new file with or without compression and/or chunking.

    Deleted Functions

    The following function has been removed in this release.
     
    C++ wrapper:
    CompType::getMemberDims

    Functions with Changed Syntax

    The following functions have changed as noted.

    C functions:
    H5Pset_fapl_multi
    The prototype for this function was changed from:
    • herr_t H5Pset_fapl_multi (hid_t fapl_id, const H5FD_mem_t * memb_map, const hid_t * memb_fapl, const char ** memb_name, const haddr_t * memb_addr, hbool_t relax)
    to:
    • herr_t H5Pset_fapl_multi (hid_t fapl_id, const H5FD_mem_t * memb_map, const hid_t * memb_fapl, const char * const * memb_name, const haddr_t * memb_addr, hbool_t relax)

    This change should not appreciably affect application programs.

    H5Tconvert
    The prototype for this function was changed from:
    • herr_t H5Tconvert (hid_t src_id, hid_t dst_id, hsize_t nelmts, void * buf, void * background, hid_t plist_id)
    to:
    • herr_t H5Tconvert (hid_t src_id, hid_t dst_id, size_t nelmts, void * buf, void * background, hid_t plist_id)

    This was changed to prevent overflows when hsize_t and size_t types are different sizes. Application code may need to be modified to take this into account. Application code using this function may also be affected by the changes to H5Tregister and H5Tunregister described below.

    H5Tregister and H5Tunregister
    These two routines are affected by the change to the H5T_conv_t typedef (described below) and may require application registered datatype conversion routines to be modified to conform to the changed typedef.
     
    C++ wrappers:
    H5::Exception and its subclasses
    Constructors used by H5::Exception and its subclasses that were previously overloaded to take char pointers have been removed. Constructors that passed in a reference of string have been changed to pass by value. In addition, the default value of the detailed message has been changed from 0/NULL to DEFAULT_MSG (meaning "No detailed information provided").
     
    DSetCreatPropList::setLayout
    The prototype for DSetCreatPropList::setLayout has been changed: the first parameter has been removed.

    Constants with Changed Values

    The following library structures have changed as noted.

    C API:
    H5T_conv_t
    This function pointer typedef's definition has been changed from:
    • typedef herr_t (*H5T_conv_t) (hid_t src_id, hid_t dst_id, H5T_cdata_t * cdata, hsize_t nelmts, size_t buf_stride, size_t bkg_stride, void * buf, void * bkg, hid_t plist_id)
    to:
    • typedef herr_t (*H5T_conv_t) (hid_t src_id, hid_t dst_id, H5T_cdata_t * cdata, size_t nelmts, size_t buf_stride, size_t bkg_stride, void * buf, void * bkg, hid_t plist_id)

    This was changed to prevent overflows when hsize_t and size_t types are different sizes. Application code may need to be modified to take this into account.

     

    Release 1.6.2 versus Release 1.6.1

    This section lists the API-level changes that have been made in the transition from the HDF5 Release 1.6.1 to Release 1.6.2.

    New Functions and Tools

    C functions:
    The following C functions are new for Release 1.6.2 and are documented in the HDF5 Reference Manual.
    H5Iget_ref      int H5Iget_ref (hid_t obj_id)
    See entry.
    H5Iinc_ref      int H5Iinc_ref (hid_t obj_id)
    See entry.
    H5Idec_ref      int H5Idec_ref (hid_t obj_id)
    See entry.
     
    Fortran subroutines:
    The following Fortran90 subroutines are new for Release 1.6.2 and are documented in the HDF5 Reference Manual.
    Corresponding to the new C functions listed above:
        h5iget_ref_f
        h5iinc_ref_f
        h5idec_ref_f
        
     
    Tools:
    The following tools are new for Release 1.6.2 and are documented on the Tools page of the HDF5 Reference Manual.
    h5pcc is designed to aid in the compilation of C applications that employ the HDF5 Library.
    h5pfc is designed to aid in the compilation of Fortran90 applications that employ the HDF5 Library.

    Deleted Functions

    None.

    Functions with Changed Syntax

    None.

    Constants with Changed Values

    None.

     

    Release 1.6.1 versus Release 1.6.0

    This section lists the API-level changes that have been made in the transition from the HDF5 Release 1.6.0 to Release 1.6.1.

    New Functions and Tools

    C functions:
    The following C function is new for Release 1.6.1 and is documented in the HDF5 Reference Manual.
    H5Fget_freespace      hssize_t H5Fget_freespace (hid_t file_id)
    See entry.
     
    Fortran subroutines
    The following Fortran90 subroutines were new for Release 1.6.0 but were not documented. They are now included in the HDF5 Reference Manual.
    h5get_fapl_mpiposix_f      h5pget_fapl_mpiposix_f(prp_id, comm, use_gpfs, hdferr)
    See entry.
    h5set_fapl_mpiposix_f      h5pset_fapl_mpiposix_f(prp_id, comm, use_gpfs, hdferr)
    See entry.
     
    Tools:
    Release 1.6.1 contains no new tools.

    Deleted Functions

    None.

    Functions with Changed Syntax

    The following functions have changed as noted.
    C functions:
    H5Gget_obj_info
    The H5G_stat_t struct contains two new fields.
    This change will be transparent to existing applications, though those calling H5Gget_obj_info will have to be recompiled before linking with the updated library.
     
    Fortran90 subroutines:
    h5pset_cache_f
    The rdcc_nbytes parameter has changed from INTEGER to INTEGER(SIZE_T) to better match the C API and the h5pget_cache_f subroutine.

    Constants with Changed Values

    None.

     

    Release 1.6.0 versus Release 1.4.5

    This section lists the API-level changes that have been made in the transition from the HDF5 Release 1.4.x series to Release 1.6.0.

    New Functions and Tools

    The following functions are new for Release 1.6.0 and are included in the HDF5 Reference Manual.
    H5set_free_list_limits herr_t H5set_free_list_limits (int reg_global_lim, int reg_list_lim, int arr_global_lim, int arr_list_lim, int blk_global_lim, int blk_list_lim)
    H5Dget_offset hsize_t H5Dget_offset (hid_t dset_id)
    H5Dget_space_status hid_t H5Dget_space_status (hid_t dset_id, H5D_space_status_t *status)
    H5Fget_obj_ids int H5Fget_obj_ids (hid_t file_id, unsigned int types, int max_objs, hid_t *obj_id_list)
    H5Fget_vfd_handle herr_t H5Fget_vfd_handle (hid_t file_id, hid_t fapl_id, void *file_handle)
    H5Gget_num_objs herr_t H5Gget_num_objs (hid_t loc_id, hsize_t* num_obj)
    H5Gget_objname_by_idx ssize_t H5Gget_objname_by_idx (hid_t group_id, hsize_t idx, char *name, size_t* size)
    H5Gget_objtype_by_idx int H5Gget_objtype_by_idx (hid_t group_id, hsize_t idx)
    H5Iget_name ssize_t H5Iget_name (hid_t obj_id, char *name, size_t size)
    H5Pall_filters_avail htri_t H5Pall_filters_avail (hid_t dcpl_id)
    H5Pfill_value_defined herr_t H5Pfill_value_defined (hid_t plist_id, H5D_fill_value_t *status)
    H5Pget_alloc_time herr_t H5Pget_alloc_time (hid_t plist_id, H5D_alloc_time_t *alloc_time)
    H5Pget_edc_check H5Z_EDC_t H5Pget_edc_check (hid_t plist)
    H5Pget_family_offset herr_t H5Pget_family_offset (hid_t fapl_id, hsize_t *offset)
    H5Pget_fapl_mpiposix herr_t H5Pget_fapl_mpiposix (hid_t fapl_id, MPI_Comm *comm)
    H5Pget_fclose_degree herr_t H5Pget_fclose_degree(hid_t fapl_id, H5F_close_degree_t *fc_degree)
    (This item corrected 14 September 2004.)
    H5Pget_fill_time herr_t H5Pget_fill_time (hid_t plist_id, H5D_fill_time_t *fill_time)
    H5Pget_filter_by_id herr_t H5Pget_filter_by_id (hid_t plist_id, H5Z_filter_t filter, unsigned int *flags, size_t *cd_nelmts, unsigned int cd_values[], size_t namelen, char *name[])
    H5Pget_hyper_vector_size herr_t H5Pget_hyper_vector_size (hid_t dxpl_id, size_t *vector_size)
    H5Pget_multi_type herr_t H5Pget_multi_type (hid_t fapl_id, H5FD_mem_t *type)
    H5Pmodify_filter herr_t H5Pmodify_filter (hid_t plist, H5Z_filter_t filter, unsigned int flags, size_t cd_nelmts, const unsigned int cd_values[])
    H5Pset_alloc_time herr_t H5Pset_alloc_time (hid_t plist_id, H5D_alloc_time_t alloc_time)
    H5Pset_edc_check herr_t H5Pset_edc_check (hid_t plist, H5Z_EDC_t check)
    H5Pset_family_offset herr_t H5Pset_family_offset (hid_t fapl_id, hsize_t offset)
    H5Pset_fapl_mpiposix herr_t H5Pset_fapl_mpiposix (hid_t fapl_id, MPI_Comm comm)
    H5Pset_fclose_degree herr_t H5Pset_fclose_degree(hid_t fapl_id, H5F_close_degree_t fc_degree)
    (This item corrected 14 September 2004.)
    H5Pset_fill_time herr_t H5Pset_fill_time (hid_t plist_id, H5D_fill_time_t fill_time)
    H5Pset_filter herr_t H5Pset_filter (hid_t plist, H5Z_filter_t filter, unsigned int flags, size_t cd_nelmts, const unsigned int cd_values[])
    H5Pset_filter_callback herr_t H5Pset_filter_callback (hid_t plist, H5Z_filter_func_t func, void *op_data)
    H5Pset_fletcher32 herr_t H5Pset_fletcher32 (hid_t plist)
    H5Pset_hyper_vector_size  herr_t H5Pset_hyper_vector_size (hid_t dxpl_id, size_t vector_size)
    H5Pset_multi_type herr_t H5Pset_multi_type (hid_t fapl_id, H5FD_mem_t type)
    H5Pset_shuffle herr_t H5Pset_shuffle (hid_t plist_id)
    H5Pset_szip herr_t H5Pset_szip (hid_t plist, unsigned int options_mask, unsigned int pixels_per_block)
    H5Rget_object_type int H5Rget_object_type (hid_t id, void *ref)
    H5Sget_select_type H5S_sel_type H5Sget_select_type (hid_t space_id)
    H5Tdetect_class htri_t H5Tdetect_class (hid_t dtype_id, H5T_class_t dtype_class)
    H5Tget_native_type hid_t H5Tget_native_type (hid_t type_id, H5T_direction_t direction)
    H5Tis_variable_str htri_t H5Tis_variable_str (hid_t dtype_id)
    H5Zfilter_avail herr_t H5Zfilter_avail (H5Z_filter_t filter)
    H5Zunregister herr_t H5Zunregister (H5Z_filter_t filter)
     
    The following tools are new for Release 1.6.0 and are included in the HDF5 Reference Manual.
    h5diff
    h5import
    h5fc
    h5c++
    h5perf
    h5redeploy

    Deleted Functions

    The following functions are deprecated in HDF5 Release 1.6.0. A backward compatibility mode is provided in this release, enabling these functions and other Release 1.4.x compatibility features, but is available only when the HDF5 Library is configured with the flag H5_WANT_H5_V1_4_COMPAT. The backward compatibility mode is not enabled in the binaries distributed by NCSA.
           
    H5Pset_hyper_cache
    H5Pget_hyper_cache
    
          
    H5Rget_object_type
    
          
     
    
    

    The above functions will eventually be removed from the HDF5 distribution and from the HDF5 Reference Manual.

    Functions with Changed Syntax

    The following functions have changed as noted.
    C functions:
    H5FDflush and VFL "flush" callbacks
    An extra parameter closing has been added to these functions, to allow the library to indicate that the file will be closed following the call to "flush". Actions in the "flush" call that are duplicated in the VFL "close" call may be omitted by the VFL driver.
    * H5Gget_objtype_by_idx
    The function return type has changed from int to the enumerated type H5G_obj_t.
    * H5Pset(get)_buffer
    The size parameter for H5Pset_buffer has changed from type hsize_t to size_t.
    The H5Pget_buffer return type has similarly changed from hsize_t to size_t.
    * H5Pset(get)_cache
    The rdcc_nbytes parameter has changed from type int to size_t.
    (This item corrected 3 March 2004.)
    * H5Pset_fapl_log
    The verbosity parameter has been removed.
    Two new parameters have been added: flags of type unsigned and buf_size of type size_t.
    * H5Pset(get)_fapl_mpiposix
    A use_gpfs parameter of type hbool_t has been added.
    * H5Pset(get)_sieve_buf_size
    The size parameter has changed from type hsize_t to size_t.
    * H5Pset(get)_sym_k
    The lk parameter has changed from type int to unsigned.
    * H5Sget_select_bounds
    The start and end parameters have changed from type hsize_t * to hssize_t * to better match the rest of the dataspace API.
    * H5Zregister
    This function is substantially revised in Release 1.6.0 with a new H5Z_class_t struct and new set local and can apply callback functions.
     
    Fortran90 functions:
    h5pset(get)_fapl_core_f
    The backing_store parameter has changed from INTEGER to LOGICAL to better match the C API.
    h5pset(get)_preserve_f
    The flag parameter has changed from INTEGER to LOGICAL to better match the C API.

    Backward compatibility with the Release 1.4.x syntax is available for the functions indicated above with a leading asterisk (*). The backward compatibility features are available only when the HDF5 Library is configured with the flag H5_WANT_H5_V1_4_COMPAT, is not enabled in the binaries distributed by NCSA, and will eventually be removed from the HDF5 distribution.

    Constants with Changed Values

     

    Release 1.4.5 versus Release 1.4.4

    C Library

    Added functions:
    herr_t H5Pset_fapl_mpiposix(hid_t fapl_id, MPI_Comm comm);
    herr_t H5Pget_fapl_mpiposix(hid_t fapl_id, MPI_Comm *comm/*out*/);
    
    Changed functions: The following functions have changed behavior.

    H5Pset_fapl_mpio  
    H5Pget_fapl_mpio
    H5Fcreate
    H5Fopen
    H5Fclose
    Previously, the Communicator and Info object arguments supplied to H5Pset_fapl_mpio were stored in the property with its handle values. This meant changes to the communicator or the Info object after calling H5Pset_fapl_mpio would affect the how the property list functioned. This was also the case when H5Fopen/create operated. They just stored the handle value. This is not according to the MPI-2 defined behavior of how Info objects should be handled. (MPI-2 defines Info objects must be parsed when called.)
    H5Pset_fapl_mpio now stores a duplicate of each of the communicator and Info object.
    H5Pget_fapl_mpio now returns a duplicate of its stored communicator and Info object. It is now the responsibility of the applications to free those objects when done.

    H5Fcreate and H5Fopen also store a duplicate of the communicator and Info object supplied by the file access property List. H5Fclose frees the duplicates.

    Advice to users: User applications should release the communicator and Info object returned by H5Pget_fapl_mpio when they are no longer needed.

    Removed functions:
    None       
              
    
    There were no other public API changes in the C library for this release.

    Fortran90 Library

    The following missing Fortran functions were added:

    h5get_libversion_f, h5check_version_f, h5garbage_collect_f, h5dont_atexit_f
    h5tget_member_index_f, h5tvlen_create_f
    h5dget_storage_size_f, h5dvlen_get_max_len_f , h5dwrite_vl_f, h5dread_vl_f

    Only integer, real and character types are supported for VL datatypes.

    Release 1.4.4 versus Release 1.4.3

    C Library

    Added functions:
    H5Pget_small_data_block_size
    H5Pset_small_data_block_size
    H5Tget_member_index
    
          
              
    
    Changed functions:
    None       
              
    
    Removed functions:
    None       
              
    
    There were no other public API changes in the C library for this release.

    Fortran90 Library

    h5dwrite_f, h5dread_f, h5awrite_f, h5aread_f were overloaded with dims argument to be assumed size array of type INTEGER(HSIZE_T). We recommend to use the subroutines with the new type. Module subroutines that accept dims as INTEGER array of size 7 will be deprecated in the 1.6.0 release.

    Release 1.4.3 versus Release 1.4.2

    C Library

    Removed function:
    H5Pset_fapl_dpss 
          
              
    
          
              
    
    There were no other public API changes in the C library for this release.

    Fortran90 Library

    There were no changes to the public Fortran90 APIs for this release.

    Release 1.4.2 versus Release 1.4.1

    C Library

    The HDF5 Release 1.4.2 C library is a "Bugfix Release"; there are no API changes in the underlying HDF5 Library.

    Fortran90 Library

    The following functions in the HDF5 Release 1.4.2 Fortran90 library have an additional parameter, dims, that was not present in Release 1.4.1:
    h5aread_f(attr_id, memtype_id,  buf, dims, hdferr)
    h5awrite_f(attr_id, memtype_id,  buf, dims, hdferr)
    h5dread_f(dset_id, mem_type_id, buf, dims, hdferr, mem_space_id, &
               file_space_id, xfer_prp)
    h5dwrite_f(dset_id, mem_type_id, buf, dims, hdferr, mem_space_id, &
               file_space_id, xfer_prp)
    
    The dims parameter enables library portability between the UNIX and Microsoft Windows platforms.

    Release 1.4.1 versus Release 1.4.0

    Release 1.4.1 is a "Tools Release"; there are no API changes in the underlying HDF5 Library.

    Release 1.4.0 versus Release 1.2.2

    Several functions were added to or removed from the HDF5 Library in the development of Release 1.4.0. A few functions have been modified in minor ways.

    New Functions

    The following functions are new for Release 1.4.0 and are included in the HDF5 Reference Manual.
    herr_t H5Dvlen_get_buf_size (hid_t dataset_id, hid_t type_id, 
               hid_t space_id, hsize_t *size);
    herr_t H5Epush (const char *file, const char *func,
               unsigned line, H5E_major_t maj, H5E_minor_t min, 
               const char *str);
    hid_t H5Pget_driver (hid_t plist_id);
    void *H5Pget_driver_info (hid_t plist_id);
    herr_t H5Pget_dxpl_mpio (hid_t dxpl_id, 
               H5FD_mpio_xfer_t *xfer_mode/*out*/);
    herr_t H5Pget_dxpl_multi (hid_t dxpl_id, 
               hid_t *memb_dxpl/*out*/);
    herr_t H5Pget_fapl_core (hid_t fapl_id, size_t *increment/*out*/,
               hbool_t *backing_store/*out*/) 
    herr_t H5Pget_fapl_family (hid_t fapl_id, 
               hsize_t *memb_size/*out*/, hid_t *memb_fapl_id/*out*/);
    herr_t H5Pget_fapl_mpio (hid_t fapl_id, MPI_Comm *comm/*out*/,
               MPI_Info *info/*out*/);
    herr_t H5Pget_fapl_multi (hid_t fapl_id, 
               H5FD_mem_t *memb_map/*out*/, hid_t *memb_fapl/*out*/, 
               char **memb_name/*out*/, haddr_t *memb_addr/*out*/, 
               hbool_t *relax/*out*/);
    herr_t H5Pget_fapl_stream (hid_t fapl_id,
               H5FD_stream_fapl_t *fapl /*out*/ );
    herr_t H5Pget_meta_block_size (hid_t fapl_id, 
               hsize_t *size/*out*/);
    herr_t H5Pget_sieve_buf_size (hid_t fapl_id, 
               hsize_t *size/*out*/);
    herr_t H5Pset_driver (hid_t plist_id, hid_t driver_id,
               const void *driver_info);
    herr_t H5Pset_dxpl_mpio (hid_t dxpl_id, 
               H5FD_mpio_xfer_t xfer_mode);
    herr_t H5Pset_dxpl_multi (hid_t dxpl_id, 
               const hid_t *memb_dxpl);
    herr_t H5Pset_fapl_core (hid_t fapl_id, size_t increment, 
               hbool_t backing_store)
    herr_t H5Pset_fapl_family (hid_t fapl_id, hsize_t memb_size,
               hid_t memb_fapl_id);
    herr_t H5Pset_fapl_log (hid_t fapl_id, char *logfile, 
               int verbosity);
    herr_t H5Pset_fapl_mpio (hid_t fapl_id, MPI_Comm comm, 
               MPI_Info info);
    herr_t H5Pset_fapl_multi (hid_t fapl_id, 
               const H5FD_mem_t *memb_map, const hid_t *memb_fapl, 
               const char **memb_name, const haddr_t *memb_addr, 
               hbool_t relax);
    herr_t H5Pset_fapl_sec2 (hid_t fapl_id);
    herr_t H5Pset_fapl_split (hid_t fapl, const char *meta_ext,
               hid_t meta_plist_id, const char *raw_ext,
               hid_t raw_plist_id);
    herr_t H5Pset_fapl_stdio (hid_t fapl_id);
    herr_t H5Pset_fapl_stream (hid_t fapl_id,
               H5FD_stream_fapl_t *fapl);
    herr_t H5Pset_meta_block_size(hid_t fapl_id, hsize_t size);
    herr_t H5Pset_sieve_buf_size(hid_t fapl_id, hsize_t size);
    hid_t H5Tarray_create (hid_t base, int rank, const hsize_t dims[], 
               const int perm[])
    int H5Tget_array_dims (hid_t adtype_id, hsize_t *dims[], int *perm[])
    int H5Tget_array_ndims (hid_t adtype_id)
    

    The following functions are new for Release 1.4.0, but are intended only for use in specialized environments. These are also included in the HDF5 Reference Manual.

    herr_t H5Pget_fapl_dpss (hid_t fapl_id);
    herr_t H5Pget_fapl_gass (hid_t fapl_id, GASS_Info *info/*out*/);
    herr_t H5Pget_fapl_srb (hid_t fapl_id, SRB_Info *info);
    herr_t H5Pset_fapl_dpss (hid_t fapl_id);
    herr_t H5Pset_fapl_gass (hid_t fapl_id, GASS_Info info);
    herr_t H5Pset_fapl_srb (hid_t fapl_id, SRB_Info info);
    

    The following functions are new for Release 1.4.0 but are intended only for driver development work, not for general use. They are listed in the List of VFL Functions document in the HDF5 Technical Notes. They are described in detail only in the source code and do not appear in the HDF5 Reference Manual.

    haddr_t H5FDalloc (H5FD_t *file, H5FD_mem_t type, 
              hsize_t size);
    herr_t H5FDclose (H5FD_t *file);
    int H5FDcmp (const H5FD_t *f1, const H5FD_t *f2);
    herr_t H5FDflush (H5FD_t *file);
    herr_t H5FDfree (H5FD_t *file, H5FD_mem_t type, 
              haddr_t addr, hsize_t size);
    haddr_t H5FDget_eoa (H5FD_t *file);
    haddr_t H5FDget_eof (H5FD_t *file);
    H5FD_t *H5FDopen (const char *name, unsigned flags, 
              hid_t fapl_id, haddr_t maxaddr);
    int H5FDquery (const H5FD_t *f, unsigned long *flags);
    herr_t H5FDread (H5FD_t *file, hid_t dxpl_id, haddr_t addr, 
              hsize_t size, void *buf/*out*/);
    haddr_t H5FDrealloc (H5FD_t *file, H5FD_mem_t type, 
              haddr_t addr, hsize_t old_size, hsize_t new_size);
    hid_t H5FDregister (const H5FD_class_t *cls);
    herr_t H5FDset_eoa (H5FD_t *file, haddr_t eof);
    herr_t H5FDunregister (hid_t driver_id);
    herr_t H5FDwrite (H5FD_t *file, H5FD_mem_t type, 
              hid_t dxpl_id, haddr_t addr, hsize_t size, 
              const void *buf);
    

    Deleted Functions

    The following functions have been removed from the HDF5 Library and from the HDF5 Reference Manual.
    H5Pget_core
    H5Pget_driver
    H5Pget_family
    H5Pget_mpi
    H5Pget_sec2
    H5Pget_split
    H5Pget_stdio
    H5Pget_xfer
    
          
    H5Pset_core
    H5Pset_family
    H5Pset_mpi
    H5Pset_sec2
    H5Pset_split
    H5Pset_stdio
    H5Pset_xfer
    
          
    H5RAclose
    H5RAcreate
    H5RAopen
    H5RAread
    H5RAwrite
    H5Tget_member_dims
    H5Tinsert_array
    
    Note that the entire H5RA interface, an experimental interface for ragged arrays, has been removed from the library.

    Functions with Changed Syntax

    The following functions have changed slightly.
    H5Pget_buffer
    Return type has changed to hsize_t.
    H5Pset_buffer
    The type of the size parameter has changed to hsize_t.
    H5Tconvert
    The type of the nelmts parameter has changed to hsize_t.

    Constants with Changed Values

    The values of the constants H5P_DEFAULT and H5S_ALL have been changed from -2 to 0. These default values had to be special-cased in situations where they could be returned to distinguish them from error values.

     

    Migration from Release 1.2.2 to Release 1.4.x

    H5Tinsert_array

    The functionality of H5Tinsert_array has been replaced by H5Tarray_create. Here is an example of changing code from H5Tinsert_array to H5Tarray_create.
    V1.2.2
    {
        struct tmp_struct {
            int a;
            float f[3];
            double d[2][4];
        };
        size_t f_dims[1]={3};
        size_t d_dims[2]={2,4};
        hid_t compound_type;
    
        compound_type=H5Tcreate(H5T_COMPOUND,sizeof(struct tmp_struct));
        H5Tinsert(compound_type,"a",HOFFSET(struct tmp_struct,a),H5T_NATIVE_INT);
        H5Tinsert_array(compound_type,"f",HOFFSET(struct tmp_struct,f),1,f_dims,NULL,H5T_NATIVE_FLOAT);
        H5Tinsert_array(compound_type,"d",HOFFSET(struct tmp_struct,d),2,d_dims,NULL,H5T_NATIVE_DOUBLE);
    }
    
    V1.4.0
    {
        struct tmp_struct {
            int a;
            float f[3];
            double d[2][4];
        };
        hsize_t f_dims[1]={3};
        hsize_t d_dims[2]={2,4};
        hid_t compound_type;
        hid_t array_type;
    
        compound_type=H5Tcreate(H5T_COMPOUND,sizeof(struct tmp_struct));
        H5Tinsert(compound_type,"a",HOFFSET(struct tmp_struct,a),H5T_NATIVE_INT);
        array_type=H5Tarray_create(H5T_NATIVE_FLOAT,1,f_dims,NULL);
        H5Tinsert(compound_type,"f",HOFFSET(struct tmp_struct,f),array_type);
        H5Tclose(array_type);
        array_type=H5Tarray_create(H5T_NATIVE_DOUBLE,2,d_dims,NULL);
        H5Tinsert(compound_type,"d",HOFFSET(struct tmp_struct,d),array_type);
        H5Tclose(array_type);
    }
    
    

    This and Prior Releases: The RELEASE.txt and HISTORY.txt Files

    The HDF5 source code, as distributed to users and developers, contains two files that will be of interest to readers of this document. Both files are located at the top level of the source code tree and are duplicated here for your reference:

    RELEASE.txt
    Technical notes regarding the release, including new features and the changes since the last release, notes regarding new or revised utilities, notes regarding alternative language APIs (Fortran90, C++), bugs fixed since the last release, platforms on which the release has been tested, and known problems. This is the file commonly known as "the release notes."

    HISTORY.txt
    A release-by-release history of the HDF5 Library. This file is a compiled set of the release notes (i.e., the RELEASE.txt files) from prior releases.

    HDF5 documents and links 
    Introduction to HDF5 
    HDF5 User's Guide 
    HDF5 Reference Manual 
    HDF5 Application Developer's Guide 

    The HDF Group Help Desk:
    Describes HDF5 Release 1.8.12, November 2013.
      Copyright by The HDF Group
    and the Board of Trustees of the University of Illinois
    Last modified: 14 November 2013