Please, help us to better serve our user community by answering the following short survey: https://www.hdfgroup.org/website-survey/
HDF5  1.15.0
API Reference
Deprecated List
Global H5.H5Dvlen_reclaim (long type_id, long space_id, long xfer_plist_id, byte[] buf)
As of HDF5 1.12.0 in favor of H5Treclaim
Global H5.H5Fis_hdf5 (String name)
As of HDF5 1.10.5 in favor of H5Fis_accessible.
Global H5.H5Iget_name_long (long obj_id, String[] name, long size)
Global H5.H5Oset_comment (long obj_id, String comment)
As of HDF5 1.8 in favor of object attributes.
Global H5.H5Oset_comment_by_name (long loc_id, String name, String comment, long lapl_id)
As of HDF5 1.8 in favor of object attributes.
Global h5a::h5aopen_idx_f (obj_id, index, attr_id, hdferr)
Superseded by H5Aopen_by_idx_f().
Global H5Acreate1 (hid_t loc_id, const char *name, hid_t type_id, hid_t space_id, hid_t acpl_id)

Superseded by H5Acreate2().

Superseded by H5Acreate2().

Global H5Aget_num_attrs (hid_t loc_id)

Superseded by H5Oget_info(), H5Oget_info_by_name(), and H5Oget_info_by_idx().

Superseded by H5Oget_info(), H5Oget_info_by_name(), and H5Oget_info_by_idx().

Global H5Aiterate1 (hid_t loc_id, unsigned *idx, H5A_operator1_t op, void *op_data)

Superseded by H5Aiterate2().

Superseded by H5Aiterate2().

Global H5Aopen_idx (hid_t loc_id, unsigned idx)

Superseded by H5Aopen_by_idx().

Superseded by H5Aopen_by_idx().

Global H5Aopen_name (hid_t loc_id, const char *name)

Superseded by H5Aopen_by_name().

Superseded by H5Aopen_by_name().

Global H5Dcreate1 (hid_t loc_id, const char *name, hid_t type_id, hid_t space_id, hid_t dcpl_id)

Superseded by H5Dcreate2() or the macro H5Dcreate().

Superseded by H5Dcreate2() or the macro H5Dcreate().

Global H5Dextend (hid_t dset_id, const hsize_t size[])

Superseded by H5Dset_extent().

Superseded by H5Dset_extent().

Global H5Dopen1 (hid_t loc_id, const char *name)

Superseded by H5Dopen2() or the macro H5Dopen().

Superseded by H5Dopen2() or the macro H5Dopen().

Global H5DOread_chunk (hid_t dset_id, hid_t dxpl_id, const hsize_t *offset, uint32_t *filters, void *buf)

This function was deprecated in favor of the function H5Dread_chunk() as of HDF5-1.10.3. In HDF5 1.10.3, the functionality of H5DOread_chunk() was moved to H5Dread_chunk().

For compatibility, this API call has been left as a stub which simply calls H5Dread_chunk(). New code should use H5Dread_chunk().

This function was deprecated in favor of the function H5Dread_chunk() as of HDF5-1.10.3. In HDF5 1.10.3, the functionality of H5DOread_chunk() was moved to H5Dread_chunk().

For compatibility, this API call has been left as a stub which simply calls H5Dread_chunk(). New code should use H5Dread_chunk().

Global H5DOwrite_chunk (hid_t dset_id, hid_t dxpl_id, uint32_t filters, const hsize_t *offset, size_t data_size, const void *buf)

This function was deprecated in favor of the function H5Dwrite_chunk() of HDF5-1.10.3. The functionality of H5DOwrite_chunk() was moved to H5Dwrite_chunk().

For compatibility, this API call has been left as a stub which simply calls H5Dwrite_chunk(). New code should use H5Dwrite_chunk().

This function was deprecated in favor of the function H5Dwrite_chunk() of HDF5-1.10.3. The functionality of H5DOwrite_chunk() was moved to H5Dwrite_chunk().

For compatibility, this API call has been left as a stub which simply calls H5Dwrite_chunk(). New code should use H5Dwrite_chunk().

Global H5Dvlen_reclaim (hid_t type_id, hid_t space_id, hid_t dxpl_id, void *buf)

Superseded by H5Treclaim().

Superseded by H5Treclaim().

Global H5Eclear1 (void)

1.8.0 Function H5Eclear() renamed to H5Eclear1() and deprecated in this release.

1.8.0 Function H5Eclear() renamed to H5Eclear1() and deprecated in this release.

Global H5Eget_auto1 (H5E_auto1_t *func, void **client_data)

1.8.0 Function H5Eget_auto() renamed to H5Eget_auto1() and deprecated in this release.

1.8.0 Function H5Eget_auto() renamed to H5Eget_auto1() and deprecated in this release.

Global H5Eget_major (H5E_major_t maj)

1.8.0 Function deprecated in this release.

1.8.0 Function deprecated in this release.

Global H5Eget_minor (H5E_minor_t min)

1.8.0 Function deprecated and return type changed in this release.

1.8.0 Function deprecated and return type changed in this release.

Global H5Eprint1 (FILE *stream)

1.8.0 Function H5Eprint() renamed to H5Eprint1() and deprecated in this release.

1.8.0 Function H5Eprint() renamed to H5Eprint1() and deprecated in this release.

Global H5Epush1 (const char *file, const char *func, unsigned line, H5E_major_t maj, H5E_minor_t min, const char *str)

1.8.0 Function H5Epush() renamed to H5Epush1() and deprecated in this release.

1.8.0 Function H5Epush() renamed to H5Epush1() and deprecated in this release.

Global H5Eset_auto1 (H5E_auto1_t func, void *client_data)

1.8.0 Function H5Eset_auto() renamed to H5Eset_auto1() and deprecated in this release.

1.8.0 Function H5Eset_auto() renamed to H5Eset_auto1() and deprecated in this release.

Global H5Ewalk1 (H5E_direction_t direction, H5E_walk1_t func, void *client_data)

1.8.0 Function H5Ewalk() renamed to H5Ewalk1() and deprecated in this release.

1.8.0 Function H5Ewalk() renamed to H5Ewalk1() and deprecated in this release.

Global H5F_ACC_DEBUG

In which version?

In which version?

Global H5F_file_space_type_t

1.10.1

1.10.1

Global H5Fget_info1 (hid_t obj_id, H5F_info1_t *file_info)

This function has been renamed from H5Fget_info() and is deprecated in favor of the macro H5Fget_info or the function H5Fget_info2().

This function has been renamed from H5Fget_info() and is deprecated in favor of the macro H5Fget_info or the function H5Fget_info2().

Global H5Fis_hdf5 (const char *file_name)

When?

When?

Global H5Fset_latest_format (hid_t file_id, hbool_t latest_format)

When?

When?

Global H5G_iterate_t )(hid_t group, const char *name, void *op_data)

Global H5G_obj_t

Class H5G_stat_t

Global H5Gcreate1 (hid_t loc_id, const char *name, size_t size_hint)

This function is deprecated in favor of H5Gcreate2().

This function is deprecated in favor of H5Gcreate2().

Global H5Gget_comment (hid_t loc_id, const char *name, size_t bufsize, char *buf)

This function is deprecated in favor of the function H5Oget_comment().

This function is deprecated in favor of the function H5Oget_comment().

Global H5Gget_linkval (hid_t loc_id, const char *name, size_t size, char *buf)

This function is deprecated in favor of the function H5Lget_val().

This function is deprecated in favor of the function H5Lget_val().

Global H5Gget_num_objs (hid_t loc_id, hsize_t *num_objs)

This function is deprecated in favor of the function H5Gget_info().

This function is deprecated in favor of the function H5Gget_info().

Global H5Gget_objinfo (hid_t loc_id, const char *name, hbool_t follow_link, H5G_stat_t *statbuf)

This function is deprecated in favor of the functions H5Oget_info() and H5Lget_info1().

This function is deprecated in favor of the functions H5Oget_info() and H5Lget_info1().

Global H5Gget_objname_by_idx (hid_t loc_id, hsize_t idx, char *name, size_t size)

This function is deprecated in favor of the function H5Lget_name_by_idx().

This function is deprecated in favor of the function H5Lget_name_by_idx().

Global H5Gget_objtype_by_idx (hid_t loc_id, hsize_t idx)

This function is deprecated in favor of the function H5Oget_info().

This function is deprecated in favor of the function H5Oget_info().

Global H5Giterate (hid_t loc_id, const char *name, int *idx, H5G_iterate_t op, void *op_data)

This function is deprecated in favor of the function H5Literate1().

This function is deprecated in favor of the function H5Literate1().

Global H5Glink (hid_t cur_loc_id, H5L_type_t type, const char *cur_name, const char *new_name)

This function is deprecated.

This function is deprecated.

Global H5Glink2 (hid_t cur_loc_id, const char *cur_name, H5L_type_t type, hid_t new_loc_id, const char *new_name)

This function is deprecated.

This function is deprecated.

Global H5Gmove (hid_t src_loc_id, const char *src_name, const char *dst_name)

This function is deprecated.

This function is deprecated.

Global H5Gmove2 (hid_t src_loc_id, const char *src_name, hid_t dst_loc_id, const char *dst_name)

This function is deprecated.

This function is deprecated.

Global H5Gopen1 (hid_t loc_id, const char *name)

This function is deprecated in favor of H5Gopen2().

This function is deprecated in favor of H5Gopen2().

Global H5Gset_comment (hid_t loc_id, const char *name, const char *comment)

This function is deprecated in favor of the function H5Oset_comment().

This function is deprecated in favor of the function H5Oset_comment().

Global H5Gunlink (hid_t loc_id, const char *name)

This function is deprecated in favor of the function H5Ldelete().

This function is deprecated in favor of the function H5Ldelete().

Global H5Lget_info1 (hid_t loc_id, const char *name, H5L_info1_t *linfo, hid_t lapl_id)

As of HDF5-1.12 this function has been deprecated in favor of the function H5Lget_info2() or the macro H5Lget_info().

As of HDF5-1.12 this function has been deprecated in favor of the function H5Lget_info2() or the macro H5Lget_info().

Global H5Lget_info_by_idx1 (hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, H5L_info1_t *linfo, hid_t lapl_id)

As of HDF5-1.12 this function has been deprecated in favor of the function H5Lget_info_by_idx2() and the macro H5Lget_info_by_idx().

As of HDF5-1.12 this function has been deprecated in favor of the function H5Lget_info_by_idx2() and the macro H5Lget_info_by_idx().

Global H5Literate1 (hid_t grp_id, H5_index_t idx_type, H5_iter_order_t order, hsize_t *idx, H5L_iterate1_t op, void *op_data)

Deprecated in favor of H5Literate2().

Deprecated in favor of H5Literate2().

Global H5Literate_by_name1 (hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t *idx, H5L_iterate1_t op, void *op_data, hid_t lapl_id)

As of HDF5-1.12 this function has been deprecated in favor of the function H5Literate_by_name2() or the macro H5Literate_by_name().

As of HDF5-1.12 this function has been deprecated in favor of the function H5Literate_by_name2() or the macro H5Literate_by_name().

Global H5Lvisit1 (hid_t grp_id, H5_index_t idx_type, H5_iter_order_t order, H5L_iterate1_t op, void *op_data)

As of HDF5-1.12 this function has been deprecated in favor of the function H5Lvisit2() or the macro H5Lvisit().

As of HDF5-1.12 this function has been deprecated in favor of the function H5Lvisit2() or the macro H5Lvisit().

Global H5Lvisit_by_name1 (hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, H5L_iterate1_t op, void *op_data, hid_t lapl_id)

As of HDF5-1.12 this function has been deprecated in favor of the function H5Lvisit_by_name2() or the macro H5Lvisit_by_name().

As of HDF5-1.12 this function has been deprecated in favor of the function H5Lvisit_by_name2() or the macro H5Lvisit_by_name().

Class H5O_stat_t

Global H5Oget_info1 (hid_t loc_id, H5O_info1_t *oinfo)

As of HDF5-1.12 this function has been deprecated in favor of the function H5Oget_info3() or the macro H5Oget_info.

As of HDF5-1.12 this function has been deprecated in favor of the function H5Oget_info3() or the macro H5Oget_info.

Global H5Oget_info2 (hid_t loc_id, H5O_info1_t *oinfo, unsigned fields)

As of HDF5-1.12 this function has been deprecated in favor of the function H5Oget_info3() or the macro H5Oget_info().

As of HDF5-1.12 this function has been deprecated in favor of the function H5Oget_info3() or the macro H5Oget_info().

Global H5Oget_info_by_idx1 (hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, H5O_info1_t *oinfo, hid_t lapl_id)

As of HDF5-1.12 this function has been deprecated in favor of the function H5Oget_info_by_idx3() or the macro H5Oget_info_by_idx().

As of HDF5-1.12 this function has been deprecated in favor of the function H5Oget_info_by_idx3() or the macro H5Oget_info_by_idx().

Global H5Oget_info_by_idx2 (hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, H5O_info1_t *oinfo, unsigned fields, hid_t lapl_id)

As of HDF5-1.12 this function is deprecated in favor of the function H5Oget_info_by_idx3() or the macro H5Oget_info_by_idx.

As of HDF5-1.12 this function is deprecated in favor of the function H5Oget_info_by_idx3() or the macro H5Oget_info_by_idx.

Global H5Oget_info_by_name1 (hid_t loc_id, const char *name, H5O_info1_t *oinfo, hid_t lapl_id)

As of HDF5-1.12 this function has been deprecated in favor of the function H5Oget_info_by_name2() or the macro H5Oget_info_by_name.

As of HDF5-1.12 this function has been deprecated in favor of the function H5Oget_info_by_name2() or the macro H5Oget_info_by_name.

Global H5Oget_info_by_name2 (hid_t loc_id, const char *name, H5O_info1_t *oinfo, unsigned fields, hid_t lapl_id)

As of HDF5-1.12 this function has been deprecated in favor of the function H5Oget_info_by_name3() or the macro H5Oget_info_by_name().

As of HDF5-1.12 this function has been deprecated in favor of the function H5Oget_info_by_name3() or the macro H5Oget_info_by_name().

Global H5Oopen_by_addr (hid_t loc_id, haddr_t addr)

As of HDF5-1.12 this function has been deprecated in favor of the function H5Oopen_by_token().

As of HDF5-1.12 this function has been deprecated in favor of the function H5Oopen_by_token().

Global H5Ovisit1 (hid_t obj_id, H5_index_t idx_type, H5_iter_order_t order, H5O_iterate1_t op, void *op_data)

As of HDF5-1.12 this function has been deprecated in favor of the function H5Ovisit3() or the macro H5Ovisit.

As of HDF5-1.12 this function has been deprecated in favor of the function H5Ovisit3() or the macro H5Ovisit.

Global H5Ovisit2 (hid_t obj_id, H5_index_t idx_type, H5_iter_order_t order, H5O_iterate1_t op, void *op_data, unsigned fields)

As of HDF5-1.12 this function has been deprecated in favor of the function H5Ovisit3() or the macro H5Ovisit.

As of HDF5-1.12 this function has been deprecated in favor of the function H5Ovisit3() or the macro H5Ovisit.

Global H5Ovisit_by_name1 (hid_t loc_id, const char *obj_name, H5_index_t idx_type, H5_iter_order_t order, H5O_iterate1_t op, void *op_data, hid_t lapl_id)

As of HDF5-1.12 this function has been deprecated in favor of the function H5Ovisit_by_name3() or the macro H5Ovisit_by_name.

As of HDF5-1.12 this function has been deprecated in favor of the function H5Ovisit_by_name3() or the macro H5Ovisit_by_name.

Global H5Ovisit_by_name2 (hid_t loc_id, const char *obj_name, H5_index_t idx_type, H5_iter_order_t order, H5O_iterate1_t op, void *op_data, unsigned fields, hid_t lapl_id)

As of HDF5-1.12 this function has been deprecated in favor of the function H5Ovisit_by_name3() or the macro H5Ovisit_by_name.

As of HDF5-1.12 this function has been deprecated in favor of the function H5Ovisit_by_name3() or the macro H5Ovisit_by_name.

Global H5Pencode1 (hid_t plist_id, void *buf, size_t *nalloc)

As of HDF5-1.12 this function has been deprecated in favor of H5Pencode2() or the macro H5Pencode().

As of HDF5-1.12 this function has been deprecated in favor of H5Pencode2() or the macro H5Pencode().

Global H5Pget_file_space (hid_t plist_id, H5F_file_space_type_t *strategy, hsize_t *threshold)

When was this function deprecated?

When was this function deprecated?

Global H5Pget_filter1 (hid_t plist_id, unsigned filter, unsigned int *flags, size_t *cd_nelmts, unsigned cd_values[], size_t namelen, char name[])

When was this function deprecated?

When was this function deprecated?

Global H5Pget_filter_by_id1 (hid_t plist_id, H5Z_filter_t id, unsigned int *flags, size_t *cd_nelmts, unsigned cd_values[], size_t namelen, char name[])

As of HDF5-1.8 this function was deprecated in favor of H5Pget_filter_by_id2() or the macro H5Pget_filter_by_id().

As of HDF5-1.8 this function was deprecated in favor of H5Pget_filter_by_id2() or the macro H5Pget_filter_by_id().

Global H5Pget_preserve (hid_t plist_id)

{H5Pget_preserve() is deprecated as it is no longer useful; compound datatype field preservation is now core functionality in the HDF5 library.}

{H5Pget_preserve() is deprecated as it is no longer useful; compound datatype field preservation is now core functionality in the HDF5 library.}

Global H5Pget_version (hid_t plist_id, unsigned *boot, unsigned *freelist, unsigned *stab, unsigned *shhdr)

Deprecated in favor of the function H5Fget_info()

Deprecated in favor of the function H5Fget_info()

Global H5Pinsert1 (hid_t plist_id, const char *name, size_t size, void *value, H5P_prp_set_func_t prp_set, H5P_prp_get_func_t prp_get, H5P_prp_delete_func_t prp_delete, H5P_prp_copy_func_t prp_copy, H5P_prp_close_func_t prp_close)

As of HDF5-1.8 this function was deprecated in favor of H5Pinsert2() or the macro H5Pinsert().

As of HDF5-1.8 this function was deprecated in favor of H5Pinsert2() or the macro H5Pinsert().

Global H5Pregister1 (hid_t cls_id, const char *name, size_t size, void *def_value, H5P_prp_create_func_t prp_create, H5P_prp_set_func_t prp_set, H5P_prp_get_func_t prp_get, H5P_prp_delete_func_t prp_del, H5P_prp_copy_func_t prp_copy, H5P_prp_close_func_t prp_close)

As of HDF5-1.8 this function was deprecated in favor of H5Pregister2() or the macro H5Pregister().

As of HDF5-1.8 this function was deprecated in favor of H5Pregister2() or the macro H5Pregister().

Global H5Pset_file_space (hid_t plist_id, H5F_file_space_type_t strategy, hsize_t threshold)

When was this function deprecated?

When was this function deprecated?

Global H5Pset_preserve (hid_t plist_id, hbool_t status)

This function is deprecated as it no longer has any effect; compound datatype field preservation is now core functionality in the HDF5 library.

This function is deprecated as it no longer has any effect; compound datatype field preservation is now core functionality in the HDF5 library.

Global H5PTcreate_fl (hid_t loc_id, const char *dset_name, hid_t dtype_id, hsize_t chunk_size, int compression)

This function was deprecated in favor of the function H5PTcreate().

This function was deprecated in favor of the function H5PTcreate().

Global H5Rdereference1 (hid_t obj_id, H5R_type_t ref_type, const void *ref)

This function has been renamed from H5Rdereference() and is deprecated in favor of the macro H5Rdereference() or the function H5Rdereference2().

This function has been renamed from H5Rdereference() and is deprecated in favor of the macro H5Rdereference() or the function H5Rdereference2().

Global H5Rget_obj_type1 (hid_t id, H5R_type_t ref_type, const void *ref)

This function has been renamed from H5Rget_obj_type() and is deprecated in favor of the macro H5Rget_obj_type() or the function H5Rget_obj_type2().

This function has been renamed from H5Rget_obj_type() and is deprecated in favor of the macro H5Rget_obj_type() or the function H5Rget_obj_type2().

Global H5Sencode1 (hid_t obj_id, void *buf, size_t *nalloc)

Deprecated in favor of H5Sencode2()

Deprecated in favor of H5Sencode2()

Global H5Tarray_create1 (hid_t base_id, int ndims, const hsize_t dim[], const int perm[])

This function has been renamed from H5Tarray_create() and is deprecated in favor of the macro H5Tarray_create or the function H5Tarray_create2().

This function has been renamed from H5Tarray_create() and is deprecated in favor of the macro H5Tarray_create or the function H5Tarray_create2().

Global H5Tcommit1 (hid_t loc_id, const char *name, hid_t type_id)

This function has been renamed from H5Tcommit() and is deprecated in favor of the macro H5Tcommit or the function H5Tcommit2().

This function has been renamed from H5Tcommit() and is deprecated in favor of the macro H5Tcommit or the function H5Tcommit2().

Global H5Tget_array_dims1 (hid_t type_id, hsize_t dims[], int perm[])

This function has been renamed from H5Tget_array_dims() and is deprecated in favor of the macro H5Tget_array_dims or the function H5Tget_array_dims2().

This function has been renamed from H5Tget_array_dims() and is deprecated in favor of the macro H5Tget_array_dims or the function H5Tget_array_dims2().

Global H5Topen1 (hid_t loc_id, const char *name)

This function has been renamed from H5Topen() and is deprecated in favor of the macro H5Topen or the function H5Topen2().

This function has been renamed from H5Topen() and is deprecated in favor of the macro H5Topen or the function H5Topen2().

Class hdset_reg_ref_t

Dataset region reference type that is used with deprecated reference APIs.

Dataset region reference type that is used with deprecated reference APIs.

Global hobj_ref_t

Deprecated object reference type that is used with deprecated reference APIs.

Deprecated object reference type that is used with deprecated reference APIs.