Determines whether times associated with an object are being recorded
Procedure:
H5P_GET_OBJ_TRACK_TIMES ( ocpl_id, track_times )
Signature:
herr_t H5Pget_obj_track_times(
hid_t ocpl_id,
hbool_t *track_times
)
Replace this text with the Fortran function signature
Parameters:
hid_t ocpl_id | IN: Object creation property list identifier |
hbool_t *track_times | OUT: Boolean value, 1 (TRUE) or 0 (FALSE) , specifying whether object times are being recorded |
Description:
H5P_GET_OBJ_TRACK_TIMES queries the object creation property list, ocpl_id
, to determine whether object times are being recorded.
If track_times
is returned as 1
, times are being recorded; if track_times
is returned as 0
, times are not being 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
See H5P_SET_OBJ_TRACK_TIMES for further discussion.
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 | 10:13 AM