Page tree

The license could not be verified: License Certificate has expired!

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Content Layer
id1195548671
Content Column
width50.00001%
id1195578110
classrm_pagetree_col mobile-hide
Content Block
id1195578111
 
Content Column
width50.00001%
id1195548673
classhdf-rm-main-column
Content Block
id1195548672

Include Content
render-without-blockstrue
page.rm-navbar
HTML Wrap
classhdf-print-only

Page Title

HTML Wrap
classhdf-rm-summary-block

Hdf rm anchor
AnchorNamesummary

Excerpt

Sets creation order tracking and indexing for links in a group

HTML Wrap
classhdf-rm-content-block

Hdf rm anchor
AnchorNameprocedure

HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf_procedure

H5P_SET_LINK_CREATION_ORDER  ( gcpl_id, crt_order_flags )

Hdf rm anchor
AnchorNamesignature

HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf-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_link_creation_order(
        hid_t gcpl_id,
        unsigned crt_order_flags
    )

  </code></pre>
HTML Wrap
classhdf-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_link_creation_order_f 

SUBROUTINE h5pset_link_creation_order_f(gcpl_id, crt_order_flags, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: gcpl_id  ! File access property list identifier
  INTEGER, INTENT(IN) :: crt_order_flags ! Creation order flag(s):
                                         !   H5P_CRT_ORDER_TRACKED_F
                                         !   H5P_CRT_ORDER_INDEXED_F
  INTEGER, INTENT(OUT) :: hdferr         ! Error code
                                         ! 0 on success and -1 on failure
END SUBROUTINE h5pset_link_creation_order_f</code></pre>

Hdf rm anchor
AnchorNameparameters

HTML Wrap
classhdf-rm-section
hid_t gcpl_idIN: Group creation property list identifier
unsigned  crt_order_flags    IN: Creation order flag(s)

Hdf rm anchor
AnchorNamedescription

HTML Wrap
classhdf-rm-section

H5P_SET_LINK_CREATION_ORDER sets flags for tracking and indexing links on creation order in groups created with the group creation property list gcpl_id.

crt_order_flags contains flags with the following meanings:

H5P_CRT_ORDER_TRACKEDLink creation order is tracked but not necessarily indexed
H5P_CRT_ORDER_INDEXED    Link creation order is indexed (requires H5P_CRT_ORDER_TRACKED)

Default behavior is that link creation order is neither tracked nor indexed.

H5P_SET_LINK_CREATION_ORDER can be used to set link creation order tracking, or to set link creation order tracking and indexing.

The default behavior is that links are tracked and indexed by name, and link creation order is neither tracked nor indexed. The name is always the primary index for links in a group.

H5P_SET_LINK_CREATION_ORDER can be used to set link creation order tracking, or to set link creation order tracking and indexing.

If (H5P_CRT_ORDER_TRACKED | H5P_CRT_ORDER_INDEXED) is specified for crt_order_flags, then links will be tracked and indexed by creation order. The creation order is added as a secondary index and enables faster queries and iterations by creation order.

 If just H5P_CRT_ORDER_TRACKED is specified for crt_order_flags, then links will be tracked by creation order, but not indexed by creation order.  Queries and iterations by creation order will work but will be much slower for large groups than if H5P_CRT_ORDER_INDEXED had been included.

Note that if a creation order index is to be built, it must be specified in the group creation property list. HDF5 currently provides no mechanism to turn on link creation order tracking at group creation time and to build the index later.

Hdf rm anchor
AnchorNamereturns

HTML Wrap
classhdf-rm-section

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

Hdf rm anchor
AnchorNameexample

HTML Wrap
classhdf-rm-section

Coming Soon!

Comment (Hide)
HTML Wrap
classhdf-togglebox hdf-c

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathexamples/h5_subset.c
showLineNumberstrue
lineStart32
progLangcpp
lineEnd42
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathfortran/examples/compound.f90
showLineNumberstrue
lineStart25
progLangplain
lineEnd35
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

Hdf rm anchor
AnchorNamehistory

HTML Wrap
classhdf-rm-section
Release    Change
1.8.0Function introduced in this release.