Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5P_FREE_MERGE_COMMITTED_DTYPE_PATHS

Clears the list of paths stored in the object copy property list

Procedure:

H5P_FREE_MERGE_COMMITTED_DTYPE_PATHS ( ocpypl_id )

Signature:

herr_t H5Pfree_merge_committed_dtype_paths(
            hid_t ocpypl_id
        )
  

Parameters:
hid_t ocpypl_idIN: Object copy property list identifier

Description:

H5P_FREE_MERGE_COMMITTED_DTYPE_PATHS clears the suggested paths stored in the object copy property list ocpypl_id. These are the suggested paths previously set with H5Padd_merge_committed_dtype_path.

Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Failure Modes:
H5P_FREE_MERGE_COMMITTED_DTYPE_PATHS will fail if the object copy property list is invalid.

Example Usage:
This example adds a suggested path to the object copy property list, does the copy, clears the list, and then adds a new suggested path to the list for another copy.
int main(void) {
    hid_t ocpypl_id = H5Pcreate(H5P_OBJECT_COPY);

    /* Enable the merging committed datatype feature. */
    H5Pset_copy_object(ocpypl_id, H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG);

    /* Add a path to search for a matching committed datatype. */
    H5Padd_merge_committed_dtype_path(ocpypl_id, "/group/committed_dtypeA");

    /* Do the copy. */
    H5Ocopy(...ocpypl_id...);
    ...
    ...
    /* Free the previous suggested path. */
    H5Pfree_merge_committed_dtype_paths(ocpypl_id);

    /* Add a path to search for a matching committed datatype. */
    H5Padd_merge_committed_dtype_path(ocpypl_id, "/group2/committed_dtypeB");

    /* Do the copy. */
    H5Ocopy(...ocpypl_id...);
    ...
    ...
}

 

History:
Release    Change
1.8.9C function introduced in this release.

--- Last Modified: January 05, 2018 | 02:04 PM