HDF5  1.13.0
Todo List
Global H5Ldelete_by_idx (hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, hid_t lapl_id)
We need to get the location ID story straight!
Global H5Fget_file_image (hid_t file_id, void *buf_ptr, size_t buf_len)
Fix the references.
Global H5Fget_free_sections (hid_t file_id, H5F_mem_t type, size_t nsects, H5F_sect_info_t *sect_info)
Fix the example!
Global H5Fset_latest_format (hid_t file_id, hbool_t latest_format)
Fix me!
Global H5Fis_hdf5 (const char *file_name)
Fix me!
Module H5G
Describe concisely what the functions in this module are about.
Module H5I
Describe concisely what the functions in this module are about.
Module H5L
Describe concisely what the functions in this module are about.
Global H5Lmove (hid_t src_loc, const char *src_name, hid_t dst_loc, const char *dst_name, hid_t lcpl_id, hid_t lapl_id)
We need to get the location ID story straight!
Global H5Lcreate_hard (hid_t cur_loc, const char *cur_name, hid_t dst_loc, const char *dst_name, hid_t lcpl_id, hid_t lapl_id)
We need to get the location ID story straight!
Global H5Lcreate_soft (const char *link_target, hid_t link_loc_id, const char *link_name, hid_t lcpl_id, hid_t lapl_id)
We need to get the location ID story straight!
Global H5Ldelete (hid_t loc_id, const char *name, hid_t lapl_id)
We need to get the location ID story straight!
Global H5Fget_freespace (hid_t file_id)
Fix the comment on FSM.
Global H5Lget_val (hid_t loc_id, const char *name, void *buf, size_t size, hid_t lapl_id)
We need to get the location ID story straight!
Global H5Lget_val_by_idx (hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, void *buf, size_t size, hid_t lapl_id)
We need to get the location ID story straight!
Global H5Lexists (hid_t loc_id, const char *name, hid_t lapl_id)
We need to get the location ID story straight!
Global H5Lget_info2 (hid_t loc_id, const char *name, H5L_info2_t *linfo, hid_t lapl_id)
We need to get the location ID story straight!
Global H5Lget_info_by_idx2 (hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, H5L_info2_t *linfo, hid_t lapl_id)
Document H5Lget_info_by_idx()
Global H5Lget_info1 (hid_t loc_id, const char *name, H5L_info1_t *linfo, hid_t lapl_id)
We need to get the location ID story straight!
Module H5
Describe concisely what the functions in this module are about.
Module H5O
Describe concisely what the functions in this module are about.
Module H5PL
Describe concisely what the functions in this module are about.
Module H5P

Describe concisely what the functions in this module are about.

Clicking on "more" after "Property List Interface" at the top does not work

Module H5VL
Describe concisely what the functions in this module are about.
Module H5T
Describe concisely what the functions in this module are about.
Module PDT
Fill in the blanks!
Module PDTUNIX
Fill in the blanks!
Module PDTC9x
Fill in the blanks!
Global H5Tcopy (hid_t obj_id)
Create an example for H5Tcopy().
Global H5Tcreate (H5T_class_t class, size_t size)

Original has a reference to “Creating variable-length string datatypes”.

Create an example for H5Tcreate.

Global H5Tget_size (hid_t type_id)

Original has a reference to “Creating variable-length string datatypes”.

Create an example for H5Tget_size().

Global H5Tset_size (hid_t type_id, size_t size)

Create an example for H5Tset_size().

Original has a reference to “Creating variable-length string datatypes”.

Global H5Tinsert (hid_t dtype_id, const char *name, size_t offset, hid_t field_id)
Create example for H5Tinsert
Global H5Tvlen_create (hid_t base_id)
Fix the reference.
Global H5VLregister_connector (const H5VL_class_t *cls, hid_t vipl_id)
Fix the reference to VOL documentation.
Global H5Pcreate_class (hid_t parent, const char *name, H5P_cls_create_func_t create, void *create_data, H5P_cls_copy_func_t copy, void *copy_data, H5P_cls_close_func_t close, void *close_data)
fix snippets to work, when you click on them.
Global H5VLregister_connector_by_name (const char *connector_name, hid_t vipl_id)
Fix the reference to VOL documentation.
Global H5VLregister_connector_by_value (H5VL_class_value_t connector_value, hid_t vipl_id)
Fix the reference to VOL documentation.
Module H5Z
Fix the reference.
Module H5A
Describe concisely what the functions in this module are about;add image.
Global H5Aiterate1 (hid_t loc_id, unsigned *idx, H5A_operator1_t op, void *op_data)
make prototype parameter match function (idx vs attr_num)
Module H5D
Describe concisely what the functions in this module are about.
Module H5E
Describe concisely what the functions in this module are about.
Module H5F
Describe concisely what the functions in this module are about.
Global H5Fget_create_plist (hid_t file_id)
Fix the references.
Global H5Fget_access_plist (hid_t file_id)
Fix the references.
" </dt><dd> \anchor _todo000171 Fix the reference.</dd> <dt> Global \_internalref group___h5_v_l_d_e_v#ga439c150299522a0e0f401a86d083097b "H5VLregister_connector" (const H5VL_class_t *cls, hid_t vipl_id)</dt><dd> \anchor _todo000160 Fix the reference to VOL documentation.</dd> <dt> Module \_internalref group___h5_v_l "H5VL" </dt><dd> \anchor _todo000161 Describe concisely what the functions in this module are about.</dd> <dt> Global \_internalref group___h5_v_l#gaf48d1225927e1e701656346b832ee6b1 "H5VLregister_connector_by_name" (const char *connector_name, hid_t vipl_id)</dt><dd> \anchor _todo000162 Fix the reference to VOL documentation.</dd> <dt> Global \_internalref group___h5_v_l#ga11e69930e47f654805a265f417412ea8 "H5VLregister_connector_by_value" (H5VL_class_value_t connector_value, hid_t vipl_id)</dt><dd> \anchor _todo000163 Fix the reference to VOL documentation.</dd> <dt> Module \_internalref group___h5_z "H5Z" </dt><dd> \anchor _todo000164 Fix the reference.</dd> <dt> \_internalref ""

Standardize the way we describe these macros!

Standardize the way we describe these macros!

Fix the reference.

Fix the reference.

Fix the reference.

Fix the reference.

Global H5Tset_size (hid_t type_id, size_t size)

Create an example for H5Tset_size().

Original has a reference to “Creating variable-length string datatypes”.

" </dt><dd> \anchor _todo000172 Fix the reference.<p> \anchor _todo000173 Fix the reference.<p> \anchor _todo000174 Fix reference to the document<p> \anchor _todo000175 Fix reference to the document<p> \anchor _todo000176 Fix reference to the document; exchange 1.8.8 and 1.8.0<p> \anchor _todo000177 Fix reference to the document<p> \anchor _todo000178 Fix reference to the document</dd> <dt> page \_internalref index "API Documentation for HDF5 Version 1.13 (Draft)"

Fix the search form for server deployments.

Make it mobile-friendly

Write an introduction.

Make this crystal clear!

Module H5S
Describe concisely what the functions in this module are about.
Global H5Pinsert2 (hid_t plist_id, 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)
"cpp_note" goes here
Global H5Piterate (hid_t id, int *idx, H5P_iterate_t iter_func, void *iter_data)
"cpp_note" goes here
Global H5Pregister2 (hid_t cls_id, const char *name, size_t size, void *def_value, 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)
"cpp_note" goes here
Global 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)
Signature for H5Pget_filter2 is different in H5Pocpl.c than in H5Ppublic.h
Global H5Pget_nfilters (hid_t plist_id)
Signature for H5Pget_nfilters() is different in H5Pocpl.c than in H5Ppublic.h.
Global H5Pset_deflate (hid_t plist_id, unsigned level)
H5Pset_deflate prototype does not match source code
Global H5Pset_cache (hid_t plist_id, int mdc_nelmts, size_t rdcc_nslots, size_t rdcc_nbytes, double rdcc_w0)
Check on H5Pset_fapl_mpio() and H5Pset_fapl_mpiposix().
Global H5Pget_filter1 (hid_t plist_id, unsigned idx, unsigned int *flags, size_t *cd_nelmts, unsigned cd_values[], size_t namelen, char name[])
H5Pget_filter1() prototype does not match source in H5Pocpl.c. Also, it is not in a deprecated file. Is that okay?
Global H5free_memory (void *mem)
Fix the reference to Freeing Memory Allocated by the HDF5 Library
Module H5R
Describe concisely what the functions in this module are about.
Global H5Sencode2 (hid_t obj_id, void *buf, size_t *nalloc, hid_t fapl)

Fix the references.

Fix the references.

Module H5T
Describe concisely what the functions in this module are about.
Module PDT
Fill in the blanks!
Module PDTUNIX
Fill in the blanks!
Module PDTC9x
Fill in the blanks!
Global H5Tcreate (H5T_class_t class, size_t size)

Original has a reference to “Creating variable-length string datatypes”.

Create an example for H5Tcreate.

Global H5Tcopy (hid_t obj_id)

H5Tcopy returns H5I_INVALID_HID on fail; we will need to modify return macro to include H5I_INVALID_HID instead of "negative value".

Create an example for H5Tcopy.

Global H5Tinsert (hid_t dtype_id, const char *name, size_t offset, hid_t field_id)
Create example for H5Tinsert
Global H5Tvlen_create (hid_t base_id)
Fix the reference.
Global H5Tget_size (hid_t type_id)

Original has a reference to “Creating variable-length string datatypes”.

Create an example for H5Tget_size.

Global H5Ldelete_by_idx (hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, hid_t lapl_id)
We need to get the location ID story straight!
Global H5Fget_file_image (hid_t file_id, void *buf_ptr, size_t buf_len)
Fix the references.
Global H5Fget_free_sections (hid_t file_id, H5F_mem_t type, size_t nsects, H5F_sect_info_t *sect_info)
Fix the example!
Global H5Fset_latest_format (hid_t file_id, hbool_t latest_format)
Fix me!
Global H5Fis_hdf5 (const char *file_name)
Fix me!
Module H5G
Describe concisely what the functions in this module are about.
Module H5I
Describe concisely what the functions in this module are about.
Module H5L
Describe concisely what the functions in this module are about.
Global H5Lmove (hid_t src_loc, const char *src_name, hid_t dst_loc, const char *dst_name, hid_t lcpl_id, hid_t lapl_id)
We need to get the location ID story straight!
Global H5Lcreate_hard (hid_t cur_loc, const char *cur_name, hid_t dst_loc, const char *dst_name, hid_t lcpl_id, hid_t lapl_id)
We need to get the location ID story straight!
Global H5Lcreate_soft (const char *link_target, hid_t link_loc_id, const char *link_name, hid_t lcpl_id, hid_t lapl_id)
We need to get the location ID story straight!
Global H5Ldelete (hid_t loc_id, const char *name, hid_t lapl_id)
We need to get the location ID story straight!
Global H5Fget_freespace (hid_t file_id)
Fix the comment on FSM.
Global H5Lget_val (hid_t loc_id, const char *name, void *buf, size_t size, hid_t lapl_id)
We need to get the location ID story straight!
Global H5Lget_val_by_idx (hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, void *buf, size_t size, hid_t lapl_id)
We need to get the location ID story straight!
Global H5Lexists (hid_t loc_id, const char *name, hid_t lapl_id)
We need to get the location ID story straight!
Global H5Lget_info2 (hid_t loc_id, const char *name, H5L_info2_t *linfo, hid_t lapl_id)
We need to get the location ID story straight!
Global H5Lget_info_by_idx2 (hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, H5L_info2_t *linfo, hid_t lapl_id)
Document H5Lget_info_by_idx()
Global H5Lget_info1 (hid_t loc_id, const char *name, H5L_info1_t *linfo, hid_t lapl_id)
We need to get the location ID story straight!
Module H5
Describe concisely what the functions in this module are about.
Module H5O
Describe concisely what the functions in this module are about.
Global H5Oopen (hid_t loc_id, const char *name, hid_t lapl_id)
Check I split history into version and since
Global H5Oopen_by_idx (hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, hid_t lapl_id)
Check I split history into version and since
Global H5Tget_size (hid_t type_id)

Original has a reference to “Creating variable-length string datatypes”.

Create an example for H5Tget_size().

Global H5Pinsert2 (hid_t plist_id, 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)
"cpp_note" goes here
Global H5Piterate (hid_t id, int *idx, H5P_iterate_t iter_func, void *iter_data)
"cpp_note" goes here
Global H5Pregister2 (hid_t cls_id, const char *name, size_t size, void *def_value, 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)
"cpp_note" goes here
Global 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)
Signature for H5Pget_filter2 is different in H5Pocpl.c than in H5Ppublic.h
Global H5Pget_nfilters (hid_t plist_id)
Signature for H5Pget_nfilters() is different in H5Pocpl.c than in H5Ppublic.h.
Global H5Pset_deflate (hid_t plist_id, unsigned level)
H5Pset_deflate prototype does not match source code
Global H5Pset_cache (hid_t plist_id, int mdc_nelmts, size_t rdcc_nslots, size_t rdcc_nbytes, double rdcc_w0)
Check on H5Pset_fapl_mpio() and H5Pset_fapl_mpiposix().
Global H5Pget_filter1 (hid_t plist_id, unsigned idx, unsigned int *flags, size_t *cd_nelmts, unsigned cd_values[], size_t namelen, char name[])
H5Pget_filter1() prototype does not match source in H5Pocpl.c. Also, it is not in a deprecated file. Is that okay?
Global H5Tcopy (hid_t obj_id)
Create an example for H5Tcopy().
Global H5Tcreate (H5T_class_t class, size_t size)

Original has a reference to “Creating variable-length string datatypes”.

Create an example for H5Tcreate.

Global H5Oexists_by_name (hid_t loc_id, const char *name, hid_t lapl_id)
Check I split history into version and since
Global H5Tset_size (hid_t type_id, size_t size)

Create an example for H5Tset_size().

Original has a reference to “Creating variable-length string datatypes”.

Global H5Tinsert (hid_t dtype_id, const char *name, size_t offset, hid_t field_id)
Create example for H5Tinsert
Global H5Tvlen_create (hid_t base_id)
Fix the reference.
Module H5A
Describe concisely what the functions in this module are about;add image.
Global H5Aiterate1 (hid_t loc_id, unsigned *idx, H5A_operator1_t op, void *op_data)
make prototype parameter match function (idx vs attr_num)
Module H5D
Describe concisely what the functions in this module are about.
Module H5E
Describe concisely what the functions in this module are about.
Module H5F
Describe concisely what the functions in this module are about.
Global H5Fget_create_plist (hid_t file_id)
Fix the references.
Global H5Fget_access_plist (hid_t file_id)
Fix the references.
Global H5Pset_elink_cb (hid_t lapl_id, H5L_elink_traverse_t func, void *op_data)
Add Programming Note for C++ Developers Using C Functions
Module H5P

Describe concisely what the functions in this module are about.

Clicking on "more" after "Property List Interface" at the top does not work

Global H5Pcreate_class (hid_t parent, const char *name, H5P_cls_create_func_t create, void *create_data, H5P_cls_copy_func_t copy, void *copy_data, H5P_cls_close_func_t close, void *close_data)
fix snippets to work, when you click on them.
Global H5Pinsert2 (hid_t plist_id, 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)
"cpp_note" goes here
Global H5Piterate (hid_t id, int *idx, H5P_iterate_t iter_func, void *iter_data)
"cpp_note" goes here
Global H5Pregister2 (hid_t cls_id, const char *name, size_t size, void *def_value, 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)
"cpp_note" goes here
Global 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)
Signature for H5Pget_filter2 is different in H5Pocpl.c than in H5Ppublic.h
Global H5Pget_nfilters (hid_t plist_id)
Signature for H5Pget_nfilters() is different in H5Pocpl.c than in H5Ppublic.h.
Global H5Pset_deflate (hid_t plist_id, unsigned level)
H5Pset_deflate prototype does not match source code
Global H5Pset_filter (hid_t plist_id, H5Z_filter_t filter, unsigned int flags, size_t cd_nelmts, const unsigned int c_values[])
Removed several references to links to documentation
Global H5Pget_family_offset (hid_t fapl_id, hsize_t *offset)
References the VFL documentation.
Global H5Pset_cache (hid_t plist_id, int mdc_nelmts, size_t rdcc_nslots, size_t rdcc_nbytes, double rdcc_w0)
Check on H5Pset_fapl_mpio() and H5Pset_fapl_mpiposix().
Module H5PL
Describe concisely what the functions in this module are about.
Global H5Padd_merge_committed_dtype_path (hid_t plist_id, const char *path)

Removed Example Usage.

missing link to "Copying Committed Datatypes with H5Ocopy - A comprehensive discussion of copying committed datatypes (PDF) in Advanced Topics in HDF5

Global H5Pfree_merge_committed_dtype_paths (hid_t plist_id)
Removed Example Usage.
Global H5Pget_mcdt_search_cb (hid_t plist_id, H5O_mcdt_search_cb_t *func, void **op_data)
Link to Copying Committed Datatypes with H5Ocopy was removed.
Global H5Pset_copy_object (hid_t plist_id, unsigned copy_options)
Link to Copying Committed Datatypes with H5Ocopy was removed.
Global H5Pset_mcdt_search_cb (hid_t plist_id, H5O_mcdt_search_cb_t func, void *op_data)

Removed Example Usage.

Programming Note for C++ Developers Using C Functions:

Link removed to "Copying Committed Datatypes with H5Ocopy" in Advanced Topics in HDF5

Global H5Pget_filter1 (hid_t plist_id, unsigned idx, unsigned int *flags, size_t *cd_nelmts, unsigned cd_values[], size_t namelen, char name[])
H5Pget_filter1() prototype does not match source in H5Pocpl.c. Also, it is not in a deprecated file. Is that okay?
Global H5free_memory (void *mem)
Fix the reference to Freeing Memory Allocated by the HDF5 Library
Module H5R
Describe concisely what the functions in this module are about.
Module H5S
Describe concisely what the functions in this module are about.
Global H5Oget_comment_by_name (hid_t loc_id, const char *name, char *comment, size_t bufsize, hid_t lapl_id)
Check I split history into version and since
Global H5Oget_info_by_idx3 (hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, H5O_info2_t *oinfo, unsigned fields, hid_t lapl_id)
Check: I modify description for several parameters
Global H5Oget_native_info (hid_t loc_id, H5O_native_info_t *oinfo, unsigned fields)
The parameter: oinfo is an OUT but portal says IN
Global H5Oget_native_info_by_idx (hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, H5O_native_info_t *oinfo, unsigned fields, hid_t lapl_id)
Check: I modify description for several parameters
Global H5Olink (hid_t obj_id, hid_t new_loc_id, const char *new_name, hid_t lcpl_id, hid_t lapl_id)

Correction in the example code

Check I split history into version and since

Global H5Oincr_refcount (hid_t object_id)
Check reference to user's guide
Global H5Odecr_refcount (hid_t object_id)

Check reference user's guide; check H5O_info_t

Check I split history into version and since

Global H5Ocopy (hid_t src_loc_id, const char *src_name, hid_t dst_loc_id, const char *dst_name, hid_t ocpypl_id, hid_t lcpl_id)

Check I split history into version and

Check reference to Advanced Topics

Global H5Oset_comment (hid_t obj_id, const char *comment)

Check: portal says deprecated but src is not;

Check I split history into version and since

Global H5Oset_comment_by_name (hid_t loc_id, const char *name, const char *comment, hid_t lapl_id)

Check: portal says deprecated but src is not;

Check I split history into version and since

Global H5Oget_comment (hid_t obj_id, char *comment, size_t bufsize)
Check I split history into version and since
Global H5Pcreate_class (hid_t parent, const char *name, H5P_cls_create_func_t create, void *create_data, H5P_cls_copy_func_t copy, void *copy_data, H5P_cls_close_func_t close, void *close_data)
fix snippets to work, when you click on them.
Global H5Oclose (hid_t object_id)
Check I split history into version
Global H5Odisable_mdc_flushes (hid_t object_id)
How to represent H5X_FLUSH functions
Global H5Oenable_mdc_flushes (hid_t object_id)

Check detail: there is no H5Fenable/disable_mdc_flushes functions

How to represent H5X_FLUSH functions

Check note: there is no H5Fare_mdc_flushes_disabled and H5Fdisable_md_flushes function

Global H5Oare_mdc_flushes_disabled (hid_t object_id, hbool_t *are_disabled)

Check detail: there is no H5Fenable/disable_mdc_flushes functions

Check note: there is no H5Fare_mdc_flushes_disabled function

How to represent H5XFLUSH functions

Global H5Oopen_by_addr (hid_t loc_id, haddr_t addr)

Check detail: reference to the the user guide;

Check detail: correction: H5L_infolinfo_t struct; warning: correction: H5Lget_linkinfo

Check I split history into version and since

Global H5Oget_info1 (hid_t loc_id, H5O_info1_t *oinfo)
Check H5O_VERSION_1 and H5O_VERSION_2: highlighted?
Global H5Oget_info_by_name1 (hid_t loc_id, const char *name, H5O_info1_t *oinfo, hid_t lapl_id)
Check: exchange history 1.8.8 and 1.8.0
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)
Check: I modify description for several parameters
Global H5Oget_info_by_name2 (hid_t loc_id, const char *name, H5O_info1_t *oinfo, unsigned fields, hid_t lapl_id)
check object_name v.s. name
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)
Check: I modify description for several parameters