Last modified: 21 March 2012
Name: H5Pfree_merge_committed_dtype_paths
Signature:
  herr_t `H5Pfree_merge_committed_dtype_paths`( hid_t `ocpypl_id` )

Purpose:
  Clears the list of paths stored in the object copy property list `ocpypl_id`. These are the suggested paths previously set with `H5Padd_merge_committed_dtype_path`.

Description:
  `H5Pfree_merge_committed_dtype_paths` clears the suggested paths stored in the object copy property list `ocpypl_id`.

Parameters:

  hid_t `ocpypl_id` |  | IN: Object copy property list identifier.

Returns:
  Returns a non-negative value if successful; otherwise returns a negative value.

Failure Modes:
  `H5Pfree_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...);
          ...
          ...
      }

See Also:

  `H5Ocopy` `H5Pset_copy_object` |  | `H5Pset_mcdt_search_cb` `H5Padd_merge_committed_dtype_path`

  Copying Committed Datatypes with `H5Ocopy` |  | A comprehensive discussion of copying committed datatypes (PDF) in Advanced Topics in HDF5

History:

  Release | Change
  1.8.9 | C function introduced in this release.