Last modified: 28 June 2012
Name: H5Ocopy
Signature:
herr_t 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 )

Purpose:
Copies an object in an HDF5 file.

Description:
H5Ocopy copies the group, dataset or committed datatype specified by src_name from the file or group specified by src_loc_id to the destination location dst_loc_id.

The destination location, as specified in dst_loc_id, may be a group in the current file or a location in a different file. If dst_loc_id is a file identifier, the copy will be placed in that file’s root group.

The copy will be created with the path specified in dst_name, which must not pre-exist in the destination location. If dst_name already exists at the location dst_loc_id, H5Ocopy will fail. If dst_name is an absolute path, the copy will be created relative to the file’s root group.

The copy of the object is created with the creation property lists specified by ocpypl_id and lcpl_id.

H5Ocopy will always try to make a copy of the object specified in src_name.

Several flags are available to govern the behavior of H5Ocopy:

H5Ocopy can be used to copy an object in an HDF5 file. If an object has been changed since it was opened, it should be written back to the file before using H5Ocopy. The object can be written back either by closing the object (H5Gclose, H5Oclose, H5Dclose, or H5Tclose) or by flushing the HDF5 file (H5Fflush).

Parameters:

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

See Also:
H5Pset_copy_object
H5Pset_create_intermediate_group
  H5Padd_merge_committed_dtype_path
H5Pset_mcdt_search_cb

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

Fortran90 Interface: h5ocopy_f

History: