H5P_GET_ATTR_CREATION_ORDER
Retrieves tracking and indexing settings for attribute creation order
Procedure:
H5P_GET_ATTR_CREATION_ORDER ( ocpl_id, crt_order_flags )
Signature:
herr_t H5Pget_attr_creation_order(
hid_t ocpl_id,
unsigned *crt_order_flags
)
Fortran90 Interface: h5pget_attr_creation_order_f
SUBROUTINE h5pget_attr_creation_order_f(ocpl_id, crt_order_flags, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: ocpl_id ! Object (group or dataset) creation
! property list identifier
INTEGER, INTENT(OUT) :: 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 h5pget_attr_creation_order_f
Parameters:
hid_t ocpl_id | IN: Object (group or dataset) creation property list identifier |
unsigned *crt_order_flags | OUT: Flags specifying whether to track and index attribute creation order |
Description:
H5P_GET_ATTR_CREATION_ORDER retrieves the settings 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 different types of objects may be involved.
crt_order_flags
returns flags with the following meanings:
H5P_CRT_ORDER_TRACKED | Attribute creation order is tracked but not necessarily indexed. |
H5P_CRT_ORDER_INDEXED | Attribute creation order is indexed (requires H5P_CRT_ORDER_TRACKED ). |
If crt_order_flags
is returned with a value of 0
(zero), attribute creation order is neither tracked nor indexed.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Example:
History:
Release | Change |
---|
1.8.0 | Function introduced in this release. |
--- Last Modified: June 27, 2019 | 03:32 PM