Sets the recording of times associated with an object
Procedure:
H5P_SET_OBJ_TRACK_TIMES ( ocpl_id, track_times )
Signature:
herr_t H5Pset_obj_track_times(
hid_t ocpl_id,
hbool_t track_times
)
Fortran90 Interface: h5pset_obj_track_times_f
SUBROUTINE h5pset_obj_track_times_f(plist_id, flag, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: plist_id
! Dataset creation property
! list identifier
LOGICAL, INTENT(IN) :: flag ! Object timestamp setting
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5pset_obj_track_times_f
Parameters:
hid_t ocpl_id | IN: Object creation property list identifier |
hbool_t track_times | IN: Boolean value, 1 or 0 , specifying whether object times are to be tracked |
Description:
H5P_SET_OBJ_TRACK_TIMES sets a property in the object creation property list, ocpl_id
, that governs the recording of times associated with an object.
If track_times
is set to 1
, time data will be recorded. If track_times
is set to 0
, time data will not be recorded.
Time data can be retrieved with H5O_GET_INFO
, which will return it in the H5O_info_t
struct.
If times are not tracked, they will be reported as follows when queried:
12:00 AM UDT, Jan. 1, 1970
That date and time are commonly used to represent the beginning of the UNIX epoch.
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: July 22, 2020 | 02:13 PM