Purged references to HDF5 1.13.x from the Doxygen documentation (#2365)
This commit is contained in:
@@ -694,7 +694,7 @@ H5_DLL herr_t H5Dget_chunk_info_by_coord(hid_t dset_id, const hsize_t *offset, u
|
|||||||
* Iterate over all chunked datasets and chunks in a file.
|
* Iterate over all chunked datasets and chunks in a file.
|
||||||
* \snippet H5D_examples.c H5Ovisit_cb
|
* \snippet H5D_examples.c H5Ovisit_cb
|
||||||
*
|
*
|
||||||
* \since 1.13.0
|
* \since 1.14.0
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
H5_DLL herr_t H5Dchunk_iter(hid_t dset_id, hid_t dxpl_id, H5D_chunk_iter_op_t cb, void *op_data);
|
H5_DLL herr_t H5Dchunk_iter(hid_t dset_id, hid_t dxpl_id, H5D_chunk_iter_op_t cb, void *op_data);
|
||||||
@@ -900,7 +900,7 @@ H5_DLL herr_t H5Dread(hid_t dset_id, hid_t mem_type_id, hid_t mem_space_id, hid_
|
|||||||
* parallel, each rank must pass exactly the same list of datasets in
|
* parallel, each rank must pass exactly the same list of datasets in
|
||||||
* \p dset_id , though the other parameters may differ.
|
* \p dset_id , though the other parameters may differ.
|
||||||
*
|
*
|
||||||
* \since 1.13.3
|
* \since 1.14.0
|
||||||
*
|
*
|
||||||
* \see H5Dread()
|
* \see H5Dread()
|
||||||
*
|
*
|
||||||
@@ -1091,7 +1091,7 @@ H5_DLL herr_t H5Dwrite(hid_t dset_id, hid_t mem_type_id, hid_t mem_space_id, hid
|
|||||||
* parallel, each rank must pass exactly the same list of datasets in
|
* parallel, each rank must pass exactly the same list of datasets in
|
||||||
* \p dset_id , though the other parameters may differ.
|
* \p dset_id , though the other parameters may differ.
|
||||||
*
|
*
|
||||||
* \since 1.13.3
|
* \since 1.14.0
|
||||||
*
|
*
|
||||||
* \see H5Dwrite()
|
* \see H5Dwrite()
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -39,7 +39,7 @@
|
|||||||
* while the application is performing other tasks.
|
* while the application is performing other tasks.
|
||||||
*
|
*
|
||||||
* To support AIO capabilities for the HDF5 VOL connectors, the AIO versions for the functions
|
* To support AIO capabilities for the HDF5 VOL connectors, the AIO versions for the functions
|
||||||
* listed in the table below were added to HDF5 library version 1.13.0 and later. The async version
|
* listed in the table below were added to HDF5 library version 1.14.0 and later. The async version
|
||||||
* of the function has “_async” suffix added to the function name. For example, the async version
|
* of the function has “_async” suffix added to the function name. For example, the async version
|
||||||
* for H5Fcreate is H5Fcreate_async.
|
* for H5Fcreate is H5Fcreate_async.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -152,7 +152,7 @@ extern "C" {
|
|||||||
* \details H5EScreate() creates a new event set and returns a corresponding
|
* \details H5EScreate() creates a new event set and returns a corresponding
|
||||||
* event set identifier.
|
* event set identifier.
|
||||||
*
|
*
|
||||||
* \since 1.13.0
|
* \since 1.14.0
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
H5_DLL hid_t H5EScreate(void);
|
H5_DLL hid_t H5EScreate(void);
|
||||||
@@ -185,7 +185,7 @@ H5_DLL hid_t H5EScreate(void);
|
|||||||
* immediately if an operation fails. If a failure occurs, the value
|
* immediately if an operation fails. If a failure occurs, the value
|
||||||
* returned for the number of operations in progress may be inaccurate.
|
* returned for the number of operations in progress may be inaccurate.
|
||||||
*
|
*
|
||||||
* \since 1.13.0
|
* \since 1.14.0
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
H5_DLL herr_t H5ESwait(hid_t es_id, uint64_t timeout, size_t *num_in_progress, hbool_t *err_occurred);
|
H5_DLL herr_t H5ESwait(hid_t es_id, uint64_t timeout, size_t *num_in_progress, hbool_t *err_occurred);
|
||||||
@@ -203,7 +203,7 @@ H5_DLL herr_t H5ESwait(hid_t es_id, uint64_t timeout, size_t *num_in_progress, h
|
|||||||
* \details H5EScancel() attempts to cancel operations in an event set specified
|
* \details H5EScancel() attempts to cancel operations in an event set specified
|
||||||
* by \p es_id. H5ES_NONE is a valid value for \p es_id, but functions as a no-op.
|
* by \p es_id. H5ES_NONE is a valid value for \p es_id, but functions as a no-op.
|
||||||
*
|
*
|
||||||
* \since 1.13.0
|
* \since 1.14.0
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
H5_DLL herr_t H5EScancel(hid_t es_id, size_t *num_not_canceled, hbool_t *err_occurred);
|
H5_DLL herr_t H5EScancel(hid_t es_id, size_t *num_not_canceled, hbool_t *err_occurred);
|
||||||
@@ -220,7 +220,7 @@ H5_DLL herr_t H5EScancel(hid_t es_id, size_t *num_not_canceled, hbool_t *err_occ
|
|||||||
* \details H5ESget_count() retrieves number of events in an event set specified
|
* \details H5ESget_count() retrieves number of events in an event set specified
|
||||||
* by \p es_id.
|
* by \p es_id.
|
||||||
*
|
*
|
||||||
* \since 1.13.0
|
* \since 1.14.0
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
H5_DLL herr_t H5ESget_count(hid_t es_id, size_t *count);
|
H5_DLL herr_t H5ESget_count(hid_t es_id, size_t *count);
|
||||||
@@ -241,7 +241,7 @@ H5_DLL herr_t H5ESget_count(hid_t es_id, size_t *count);
|
|||||||
* for matching operations inserted into the event set with possible
|
* for matching operations inserted into the event set with possible
|
||||||
* errors that occur.
|
* errors that occur.
|
||||||
*
|
*
|
||||||
* \since 1.13.0
|
* \since 1.14.0
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
H5_DLL herr_t H5ESget_op_counter(hid_t es_id, uint64_t *counter);
|
H5_DLL herr_t H5ESget_op_counter(hid_t es_id, uint64_t *counter);
|
||||||
@@ -259,7 +259,7 @@ H5_DLL herr_t H5ESget_op_counter(hid_t es_id, uint64_t *counter);
|
|||||||
* \details H5ESget_err_status() checks if event set specified by es_id has
|
* \details H5ESget_err_status() checks if event set specified by es_id has
|
||||||
* failed operations.
|
* failed operations.
|
||||||
*
|
*
|
||||||
* \since 1.13.0
|
* \since 1.14.0
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
H5_DLL herr_t H5ESget_err_status(hid_t es_id, hbool_t *err_occurred);
|
H5_DLL herr_t H5ESget_err_status(hid_t es_id, hbool_t *err_occurred);
|
||||||
@@ -279,7 +279,7 @@ H5_DLL herr_t H5ESget_err_status(hid_t es_id, hbool_t *err_occurred);
|
|||||||
* The function does not wait for active operations to complete, so
|
* The function does not wait for active operations to complete, so
|
||||||
* count may not include all failures.
|
* count may not include all failures.
|
||||||
*
|
*
|
||||||
* \since 1.13.0
|
* \since 1.14.0
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
H5_DLL herr_t H5ESget_err_count(hid_t es_id, size_t *num_errs);
|
H5_DLL herr_t H5ESget_err_count(hid_t es_id, size_t *num_errs);
|
||||||
@@ -303,7 +303,7 @@ H5_DLL herr_t H5ESget_err_count(hid_t es_id, size_t *num_errs);
|
|||||||
* \snippet this H5ES_err_info_t_snip
|
* \snippet this H5ES_err_info_t_snip
|
||||||
* \click4more
|
* \click4more
|
||||||
*
|
*
|
||||||
* \since 1.13.0
|
* \since 1.14.0
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
H5_DLL herr_t H5ESget_err_info(hid_t es_id, size_t num_err_info, H5ES_err_info_t err_info[],
|
H5_DLL herr_t H5ESget_err_info(hid_t es_id, size_t num_err_info, H5ES_err_info_t err_info[],
|
||||||
@@ -317,7 +317,7 @@ H5_DLL herr_t H5ESget_err_info(hid_t es_id, size_t num_err_info, H5ES_err_info_t
|
|||||||
* \param[in] err_info Array of structures
|
* \param[in] err_info Array of structures
|
||||||
* \returns \herr_t
|
* \returns \herr_t
|
||||||
*
|
*
|
||||||
* \since 1.13.0
|
* \since 1.14.0
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
H5_DLL herr_t H5ESfree_err_info(size_t num_err_info, H5ES_err_info_t err_info[]);
|
H5_DLL herr_t H5ESfree_err_info(size_t num_err_info, H5ES_err_info_t err_info[]);
|
||||||
@@ -337,7 +337,7 @@ H5_DLL herr_t H5ESfree_err_info(size_t num_err_info, H5ES_err_info_t err_info[])
|
|||||||
* Registering a new callback will replace the existing one.
|
* Registering a new callback will replace the existing one.
|
||||||
* H5ES_NONE is a valid value for 'es_id', but functions as a no-op
|
* H5ES_NONE is a valid value for 'es_id', but functions as a no-op
|
||||||
*
|
*
|
||||||
* \since 1.13.0
|
* \since 1.14.0
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
H5_DLL herr_t H5ESregister_insert_func(hid_t es_id, H5ES_event_insert_func_t func, void *ctx);
|
H5_DLL herr_t H5ESregister_insert_func(hid_t es_id, H5ES_event_insert_func_t func, void *ctx);
|
||||||
@@ -357,7 +357,7 @@ H5_DLL herr_t H5ESregister_insert_func(hid_t es_id, H5ES_event_insert_func_t fun
|
|||||||
* Registering a new callback will replace the existing one.
|
* Registering a new callback will replace the existing one.
|
||||||
* H5ES_NONE is a valid value for 'es_id', but functions as a no-op
|
* H5ES_NONE is a valid value for 'es_id', but functions as a no-op
|
||||||
*
|
*
|
||||||
* \since 1.13.0
|
* \since 1.14.0
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
H5_DLL herr_t H5ESregister_complete_func(hid_t es_id, H5ES_event_complete_func_t func, void *ctx);
|
H5_DLL herr_t H5ESregister_complete_func(hid_t es_id, H5ES_event_complete_func_t func, void *ctx);
|
||||||
@@ -372,7 +372,7 @@ H5_DLL herr_t H5ESregister_complete_func(hid_t es_id, H5ES_event_complete_func_t
|
|||||||
*
|
*
|
||||||
* \details H5ESclose() terminates access to an event set specified by \p es_id.
|
* \details H5ESclose() terminates access to an event set specified by \p es_id.
|
||||||
*
|
*
|
||||||
* \since 1.13.0
|
* \since 1.14.0
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
H5_DLL herr_t H5ESclose(hid_t es_id);
|
H5_DLL herr_t H5ESclose(hid_t es_id);
|
||||||
|
|||||||
@@ -314,7 +314,7 @@ H5_DLL hid_t H5Eget_current_stack(void);
|
|||||||
* If \p close_source_stack is \c TRUE, the source error stack
|
* If \p close_source_stack is \c TRUE, the source error stack
|
||||||
* will be closed.
|
* will be closed.
|
||||||
*
|
*
|
||||||
* \since 1.13.0
|
* \since 1.14.0
|
||||||
*/
|
*/
|
||||||
H5_DLL herr_t H5Eappend_stack(hid_t dst_stack_id, hid_t src_stack_id, hbool_t close_source_stack);
|
H5_DLL herr_t H5Eappend_stack(hid_t dst_stack_id, hid_t src_stack_id, hbool_t close_source_stack);
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -146,7 +146,7 @@ H5_DLL hid_t H5FD_ioc_init(void);
|
|||||||
* If the two drivers differ in configuration settings, application behavior
|
* If the two drivers differ in configuration settings, application behavior
|
||||||
* may not be as expected.
|
* may not be as expected.
|
||||||
*
|
*
|
||||||
* \since 1.13.2
|
* \since 1.14.0
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
H5_DLL herr_t H5Pset_fapl_ioc(hid_t fapl_id, H5FD_ioc_config_t *vfd_config);
|
H5_DLL herr_t H5Pset_fapl_ioc(hid_t fapl_id, H5FD_ioc_config_t *vfd_config);
|
||||||
@@ -170,7 +170,7 @@ H5_DLL herr_t H5Pset_fapl_ioc(hid_t fapl_id, H5FD_ioc_config_t *vfd_config);
|
|||||||
* values and then calling H5Pset_fapl_ioc() with the configured
|
* values and then calling H5Pset_fapl_ioc() with the configured
|
||||||
* H5FD_ioc_config_t structure.
|
* H5FD_ioc_config_t structure.
|
||||||
*
|
*
|
||||||
* \since 1.13.2
|
* \since 1.14.0
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
H5_DLL herr_t H5Pget_fapl_ioc(hid_t fapl_id, H5FD_ioc_config_t *config_out);
|
H5_DLL herr_t H5Pget_fapl_ioc(hid_t fapl_id, H5FD_ioc_config_t *config_out);
|
||||||
|
|||||||
@@ -336,7 +336,7 @@ H5_DLL hid_t H5FD_subfiling_init(void);
|
|||||||
* H5FD_subfiling_config_t documentation for information about configuration
|
* H5FD_subfiling_config_t documentation for information about configuration
|
||||||
* for the #H5FD_SUBFILING driver.
|
* for the #H5FD_SUBFILING driver.
|
||||||
*
|
*
|
||||||
* \since 1.13.2
|
* \since 1.14.0
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
H5_DLL herr_t H5Pset_fapl_subfiling(hid_t fapl_id, const H5FD_subfiling_config_t *vfd_config);
|
H5_DLL herr_t H5Pset_fapl_subfiling(hid_t fapl_id, const H5FD_subfiling_config_t *vfd_config);
|
||||||
@@ -370,7 +370,7 @@ H5_DLL herr_t H5Pset_fapl_subfiling(hid_t fapl_id, const H5FD_subfiling_config_t
|
|||||||
* environment variables to get accurate values for the #H5FD_SUBFILING driver
|
* environment variables to get accurate values for the #H5FD_SUBFILING driver
|
||||||
* properties.
|
* properties.
|
||||||
*
|
*
|
||||||
* \since 1.13.2
|
* \since 1.14.0
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
H5_DLL herr_t H5Pget_fapl_subfiling(hid_t fapl_id, H5FD_subfiling_config_t *config_out);
|
H5_DLL herr_t H5Pget_fapl_subfiling(hid_t fapl_id, H5FD_subfiling_config_t *config_out);
|
||||||
|
|||||||
@@ -5329,7 +5329,7 @@ H5_DLL herr_t H5Pset_vol(hid_t plist_id, hid_t new_vol_id, const void *new_vol_i
|
|||||||
* \note The H5VL_CAP_FLAG_ASYNC flag can be checked to see if asynchronous
|
* \note The H5VL_CAP_FLAG_ASYNC flag can be checked to see if asynchronous
|
||||||
* operations are supported by the VOL connector stack.
|
* operations are supported by the VOL connector stack.
|
||||||
*
|
*
|
||||||
* \since 1.13.0
|
* \since 1.14.0
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
H5_DLL herr_t H5Pget_vol_cap_flags(hid_t plist_id, uint64_t *cap_flags);
|
H5_DLL herr_t H5Pget_vol_cap_flags(hid_t plist_id, uint64_t *cap_flags);
|
||||||
@@ -8194,7 +8194,7 @@ H5_DLL herr_t H5Pget_mpio_no_collective_cause(hid_t plist_id, uint32_t *local_no
|
|||||||
* please see the documentation for that routine for details about
|
* please see the documentation for that routine for details about
|
||||||
* their use.
|
* their use.
|
||||||
*
|
*
|
||||||
* \since 1.13.0
|
* \since 1.14.0
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
H5_DLL herr_t H5Pset_dataset_io_hyperslab_selection(hid_t plist_id, unsigned rank, H5S_seloper_t op,
|
H5_DLL herr_t H5Pset_dataset_io_hyperslab_selection(hid_t plist_id, unsigned rank, H5S_seloper_t op,
|
||||||
|
|||||||
@@ -122,22 +122,14 @@
|
|||||||
* specifying a name in the VOL plugin environment variable.
|
* specifying a name in the VOL plugin environment variable.
|
||||||
*
|
*
|
||||||
* \subsubsection subsubsec_vol_quick_use Use A VOL-Enabled HDF5 Library
|
* \subsubsection subsubsec_vol_quick_use Use A VOL-Enabled HDF5 Library
|
||||||
* The virtual object layer was introduced in HDF5 1.12.0, however that version of the VOL is deprecated.
|
* The virtual object layer was introduced in HDF5 1.12.0, however that version of the VOL is deprecated
|
||||||
* VOL users should target HDF5 1.13.X, which is currently under development. The 1.13.X releases are
|
* due to inadequate support for pass-through connectors. These deficiencies have been addressed
|
||||||
* considered ”unstable” in the sense that API calls, interfaces, and the file format may change in the
|
* in HDF5 1.14.0, so VOL users and connector authors should target the 1.14.0 VOL API.
|
||||||
* 1.13.X release branches and we do not guarantee binary compatibility (”unstable” does NOT mean buggy).
|
|
||||||
* The next stable version of the library will be HDF5 1.14.0 which will release in 2023. The particular
|
|
||||||
* configuration of the library (serial vs parallel, thread-safe, debug vs production/release) does not
|
|
||||||
* matter. The VOL is a fundamental part of the library and cannot be disabled, so any build will do.
|
|
||||||
*
|
*
|
||||||
* On Windows, it’s probably best to use the same debug vs release configuration for the application and
|
* On Windows, it’s probably best to use the same debug vs release configuration for the application and
|
||||||
* all libraries in order to avoid C runtime (CRT) issues. Pre-2015 versions of Visual Studio are not
|
* all libraries in order to avoid C runtime (CRT) issues. Pre-2015 versions of Visual Studio are not
|
||||||
* supported.
|
* supported.
|
||||||
*
|
*
|
||||||
* When working with a debug HDF5 library, it’s probably also wise to build with the ”memory sanity checking”
|
|
||||||
* feature disabled to avoid accidentally clobbering our memory tracking infrastructure when dealing with
|
|
||||||
* buffers obtained from the HDF5 library. This feature should be disabled by default in HDF5 1.13.X.
|
|
||||||
*
|
|
||||||
* \subsubsection subsubsec_vol_quick_set Determine How You Will Set The VOL Connector
|
* \subsubsection subsubsec_vol_quick_set Determine How You Will Set The VOL Connector
|
||||||
* Fundamentally, setting a VOL connector involves modifying the file access property list (fapl) that will
|
* Fundamentally, setting a VOL connector involves modifying the file access property list (fapl) that will
|
||||||
* be used to open or create the file.
|
* be used to open or create the file.
|
||||||
@@ -505,7 +497,7 @@
|
|||||||
* \endcode
|
* \endcode
|
||||||
*
|
*
|
||||||
* \subsubsection subsubsec_vol_adapt_native Protect Native-Only API Calls
|
* \subsubsection subsubsec_vol_adapt_native Protect Native-Only API Calls
|
||||||
* In HDF5 1.13.0, a way to determine support for optional calls has been added.
|
* In HDF5 1.14.0, a way to determine support for optional calls has been added.
|
||||||
* \code
|
* \code
|
||||||
* herr_t H5VLquery_optional(hid_t obj_id, H5VL_subclass_t subcls, int opt_type, uint64_t *flags)
|
* herr_t H5VLquery_optional(hid_t obj_id, H5VL_subclass_t subcls, int opt_type, uint64_t *flags)
|
||||||
* \endcode
|
* \endcode
|
||||||
|
|||||||
@@ -414,7 +414,7 @@ H5_DLL herr_t H5VLquery_optional(hid_t obj_id, H5VL_subclass_t subcls, int opt_t
|
|||||||
* VOL connector object
|
* VOL connector object
|
||||||
* \return \herr_t
|
* \return \herr_t
|
||||||
*
|
*
|
||||||
* \since 1.13.0
|
* \since 1.14.0
|
||||||
*/
|
*/
|
||||||
H5_DLL herr_t H5VLobject_is_native(hid_t obj_id, hbool_t *is_native);
|
H5_DLL herr_t H5VLobject_is_native(hid_t obj_id, hbool_t *is_native);
|
||||||
|
|
||||||
|
|||||||
@@ -449,7 +449,7 @@ H5_DLL herr_t H5open(void);
|
|||||||
* If the HDF5 library is initialized and closed more than once, the
|
* If the HDF5 library is initialized and closed more than once, the
|
||||||
* \p func callback must be registered within each open/close cycle.
|
* \p func callback must be registered within each open/close cycle.
|
||||||
*
|
*
|
||||||
* \since 1.13.0
|
* \since 1.14.0
|
||||||
*/
|
*/
|
||||||
H5_DLL herr_t H5atclose(H5_atclose_func_t func, void *ctx);
|
H5_DLL herr_t H5atclose(H5_atclose_func_t func, void *ctx);
|
||||||
/**
|
/**
|
||||||
@@ -652,7 +652,7 @@ H5_DLL herr_t H5check_version(unsigned majnum, unsigned minnum, unsigned relnum)
|
|||||||
* after it has been closed. The value of \p is_terminating is
|
* after it has been closed. The value of \p is_terminating is
|
||||||
* undefined if this routine fails.
|
* undefined if this routine fails.
|
||||||
*
|
*
|
||||||
* \since 1.13.0
|
* \since 1.14.0
|
||||||
*/
|
*/
|
||||||
H5_DLL herr_t H5is_library_terminating(hbool_t *is_terminating);
|
H5_DLL herr_t H5is_library_terminating(hbool_t *is_terminating);
|
||||||
/**
|
/**
|
||||||
|
|||||||
Reference in New Issue
Block a user