Last modified: 22 March 2012
Name: H5Pset_link_creation_order
Signature:
  herr_t `H5Pset_link_creation_order`( hid_t `gcpl_id`, unsigned `crt_order_flags` )

Purpose:
  Sets creation order tracking and indexing for links in a group.

Description:
  `H5Pset_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_TRACKED` | Link 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.

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

  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.

Parameters:

  hid_t `gcpl_id` | IN: Group creation property list identifier
  unsigned `crt_order_flags` | IN: Creation order flag(s)

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

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

History:

  Release | C
  1.8.0 | Function introduced in this release.