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
)
H5Ocopy
copies the group, dataset or named 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 new copy will be created with the name dst_name
.
dst_name
must not pre-exist in the destination location;
if dst_name
already exists at the location
dst_loc_id
, H5Ocopy
will fail.
The new copy of the object is created with the creation property lists
specified by ocpypl_id
and lcpl_id
.
Several flags are available to govern the behavior of
H5Ocopy
.
These flags are set in the creation property list
cplist_id
with
H5Pset_copy_object
and
H5Pset_create_intermediate_group
.
All of the available flags are described at
H5Pset_copy_object
.
hid_t src_loc_id
|
Object identifier indicating the location of the source object to be copied |
const char *src_name
|
Name of the source object to be copied |
hid_t dst_loc_id
|
Location identifier specifying the destination |
const char *dst_name
|
Name to be assigned to the new copy |
hid_t ocpypl_id
|
Object copy property list |
hid_t lcpl_id
|
Link creation property list for the new hard link |
Release | C |
1.8.0 | Function introduced in this release. |