H5Pset_copy_object
(
hid_t ocp_plist_id
,
unsigned copy_options
)
H5Pset_copy_object
sets properties
in the object copy property list ocp_plist_id
that will be invoked when a new copy is made of an existing object.
ocp_plist_id
is the object copy property list and
specifies the properties governing the copying of the object.
Several flags, described in the following table, are available for inclusion in the object copy property list:
H5O_COPY_SHALLOW_HIERARCHY_FLAG
|
Copy only immediate members of a group.
Default behavior, without flag: Recursively copy all objects below the group. |
H5O_COPY_EXPAND_SOFT_LINK_FLAG
|
Expand soft links into new objects.
Default behavior, without flag: Keep soft links as they are. |
H5O_COPY_EXPAND_EXT_LINK_FLAG
|
Expand external link into new objects.
Default behavior, without flag: Keep external links as they are. |
H5O_COPY_EXPAND_REFERENCE_FLAG
|
Copy objects that are pointed to by references.
Default behavior, without flag: Update only the values of object references. |
H5O_COPY_WITHOUT_ATTR_FLAG
|
Copy object without copying attributes.
Default behavior, without flag: Copy object along with all its attributes. |
hid_t ocp_plist_id
|
IN: Object copy property list identifier |
unsigned copy_options
|
IN: Copy option(s) to be set |
SUBROUTINE h5pset_copy_object_f(ocp_plist_id, copy_options, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: ocp_plist_id ! Object copy property list identifier INTEGER, INTENT(IN) :: copy_options ! Copy option(s) to be set, valid options are: ! H5O_COPY_SHALLOW_HIERARCHY_F ! H5O_COPY_EXPAND_SOFT_LINK_F ! H5O_COPY_EXPAND_EXT_LINK_F ! H5O_COPY_EXPAND_REFERENCE_F ! H5O_COPY_WITHOUT_ATTR_FLAG_F
INTEGER, INTENT(OUT) :: hdferr ! Error code ! 0 on success and -1 on failure END SUBROUTINE h5pset_copy_object_f
Release | C |
1.8.0 | Function introduced in this release. |