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

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

Description:
H5Pget_copy_object retrieves the properties currently specified in the object copy property list ocp_plist_id, which will be invoked when a new copy is made of an existing object.

copy_options is a bit map indicating the flags, or properties, governing object copying that are set in the property list ocp_plist_id.

The available flags are described in H5Pset_copy_object.

Parameters:
hid_t ocp_plist_id IN: Object copy property list identifier
unsigned *copy_options     OUT: Copy option(s) set in the object copy property list

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

Fortran90 Interface: h5pget_copy_object_f
  SUBROUTINE h5pget_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(OUT) :: copy_options ! Valid copy options returned 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
    

History:
Release     C
1.8.0 Function introduced in this release.
1.8.3 Fortran subroutine introduced in this release.