Last modified: 17 August 2010
Name: H5Pset_copy_object
Signature:
herr_t H5Pset_copy_object( hid_t ocp_plist_id, unsigned copy_options )

Purpose:
Sets properties to be used when an object is copied.

Description:
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:

Parameters:
hid_t ocp_plist_id IN: Object copy property list identifier
unsigned copy_options     IN: Copy option(s) to be set

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

Fortran90 Interface: h5pset_copy_object_f
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
    

History:
Release     C
1.8.0 Function introduced in this release.