Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5P_SET_ATTR_CREATION_ORDER

Sets tracking and indexing of attribute creation order

Procedure:

H5P_SET_ATTR_CREATION_ORDER ( ocpl_id, crt_order_flags )

Signature:

herr_t H5Pset_attr_creation_order(
            hid_t ocpl_id, 
            unsigned crt_order_flags
    )

  

Fortran90 Interface: h5pset_attr_creation_order_f

SUBROUTINE h5pset_attr_creation_order_f(ocpl_id, crt_order_flags , hdferr)
  IMPLICIT NONE 
  INTEGER(HID_T), INTENT(IN) :: ocpl_id   ! Object (dataset or group) creation 
                                          ! property list identifier
  INTEGER, INTENT(IN) :: crt_order_flags  ! Flags specifying whether to track 
                                          ! and index attribute creation order
  INTEGER, INTENT(OUT) :: hdferr          ! Error code 
                                          ! 0 on success and -1 on failure
END SUBROUTINE h5pset_attr_creation_order_f
    

Parameters:
hid_t ocpl_idIN: Object creation property list identifier
unsigned crt_order_flags    IN: Flags specifying whether to track and index attribute creation order
Default: No flag set; attribute creation order is neither tracked not indexed

Description:
H5P_SET_ATTR_CREATION_ORDER sets flags for tracking and indexing attribute creation order on an object.

ocpl_id is a dataset or group creation property list identifier. The term ocpl, for object creation property list, is used when more than one type of object may be involved.

crt_order_flags contains flags with the following meanings:

H5P_CRT_ORDER_TRACKEDAttribute creation order is tracked but not necessarily indexed
H5P_CRT_ORDER_INDEXED    Attribute creation order is indexed (requires H5P_CRT_ORDER_TRACKED)

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

H5P_SET_ATTR_CREATION_ORDER can be used to set attribute creation order tracking, or to set attribute creation order tracking and indexing.

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

Returns:

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

Example:

Coming Soon!

History:
Release    C
1.8.0Function introduced in this release.

--- Last Modified: January 04, 2018 | 02:22 PM