H5P_SET_COPY_OBJECT

Content Layer

id	1195548671

Content Column

width	50.00001%
id	1195578110
class	rm_pagetree_col mobile-hide

Content Block

id	1195578111

Content Column

width	50.00001%
id	1195548673
class	hdf-rm-main-column

Content Block

id	1195548672

Include Content

render-without-blocks	true
page	.rm-navbar

HTML Wrap

class	hdf-print-only

Page Title

HTML Wrap

class	hdf-rm-summary-block

Hdf rm anchor

AnchorName	summary

Excerpt
Sets properties to be used when an object is copied

HTML Wrap

class	hdf-rm-content-block

Hdf rm anchor

AnchorName	procedure

Procedure:

HTML Wrap

class	hdf-rm-section

HTML Wrap

class	hdf_procedure

H5P_SET_COPY_OBJECT ( ocpypl_id, copy_options )

Hdf rm anchor

AnchorName	signature

Signature:

HTML Wrap

class	hdf-rm-section

HTML Wrap

class	hdf-togglebox hdf-c

HTML Add Class

	hdf-togglebutton-visible
	hdf-togglebutton-visible
selector	.hdf-togglebutton.hdf-c

HTML
<pre><code class="language-c">herr_t H5Pset_copy_object( hid_t ocpypl_id, unsigned copy_options ) </code></pre>

HTML Wrap

class	hdf-togglebox hdf-fortran hdf-togglebox-hidden

HTML Add Class

	hdf-togglebutton-visible
	hdf-togglebutton-visible
selector	.hdf-togglebutton.hdf-fortran

HTML

<pre><code class="language-fortran">Fortran90 Interface: h5pset_copy_object_f

SUBROUTINE h5pset_copy_object_f(ocpypl_id, copy_options, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: ocpypl_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
                              !   H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG_F


  INTEGER, INTENT(OUT) :: hdferr      
                              ! Error code
                              ! 0 on success and -1 on failure
END SUBROUTINE h5pset_copy_object_f
    </code></pre>

Hdf rm anchor

AnchorName	parameters

Parameters:

HTML Wrap

class	hdf-rm-section

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

Hdf rm anchor

AnchorName	description

Description:

HTML Wrap

class	hdf-rm-section

H5P_SET_COPY_OBJECT sets properties in the object copy property list ocpypl_id. When an existing object is copied, that property list will determine how the new copy is created.

The following flags are available for use in an object copy property list:

`H5O_COPY_SHALLOW_HIERARCHY_FLAG`	Copy only immediate members of a group Default behavior, without flag: Recursively copy all objects in and below the group.
`H5O_COPY_EXPAND_SOFT_LINK_FLAG`	Expand soft links into new objects Default behavior, without flag: Copy soft links as they are.
`H5O_COPY_EXPAND_EXT_LINK_FLAG`	Expand external link into new objects Default behavior, without flag: Copy external links as they are.
`H5O_COPY_EXPAND_REFERENCE_FLAG`	Copy objects that are pointed to by references and update reference values in destination file Default behavior, without flag: Set reference values in destination file to zero (`0`)
`H5O_COPY_WITHOUT_ATTR_FLAG`	Copy object without copying attributes Default behavior, without flag: Copy object with all its attributes
`H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG`	Use a matching committed datatype in the destination file when copying a committed datatype, a dataset with a committed datatype, or an object with an attribute of committed datatype Default behavior without flag: A committed datatype in the source will be copied to the destination as a committed datatype. If a dataset in the source uses a committed datatype or an object in the source has an attribute of a committed datatype, that committed datatype will be written to the destination as an anonymous committed datatype. If copied in a single H5O_COPY operation, objects that share a committed datatype in the source will share an anonymous committed dataype in the destination copy. Subsequent H5O_COPY operations, however, will be unaware of prior anonymous committed dataypes and will create new ones. See the “See Also” section immediately below for functions related to the use of this flag.

Returns:

HTML Wrap

class	hdf-rm-section

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

Hdf rm anchor

AnchorName	example

Example:

HTML Wrap

class	hdf-rm-section

Coming Soon!

Comment

HTML Wrap

class	hdf-togglebox hdf-c

Bitbucket Server file

filepath
repoSlug	hdf5
branchId	refs/heads/1.10/master
projectKey	HDFFV

examples

test/

h5_subset

lineStart
objcopy.c
showLineNumbers	true

32

progLang
10540

cpp

lineEnd
plain

42

10542
applicationLink	5ac7b370-7412-3c8c-ad20-807a68261336

Comment

HTML Wrap

class	hdf-togglebox hdf-fortran hdf-togglebox-hidden

Bitbucket Server file

repoSlug	hdf5
branchId	refs/heads/1.10/master
projectKey	HDFFV
filepath	fortran/examples/compound.f90
showLineNumbers	true
lineStart	25
progLang	plain
lineEnd	35
applicationLink	5ac7b370-7412-3c8c-ad20-807a68261336

Hdf rm anchor

AnchorName	history

History:

HTML Wrap

class	hdf-rm-section

Release	Change
1.8.9	`H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG` added in this release.
1.8.0	Function introduced in this release.

Page tree

Versions Compared

Old Version 8

New Version Current

Key

Procedure:

Signature:

Parameters:

Description:

See Also:

Returns:

Example:

History:

The HDF Group

Site

Resources

Connect