Decrements an object reference count
Procedure:
H5O_DECR_REFCOUNT(object_id)
Signature:
herr_t H5Odecr_refcount( hid_t object_id )
SUBROUTINE h5odecr_refcount_f(object_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: object_id
INTEGER , INTENT(OUT) :: hdferr
Parameters:
hid_t object_id | IN: Object identifier; may be a group, named datatype, or dataset identifier |
Description:
H5O_DECR_REFCOUNT decrements the hard link reference count for an object. It should be used any time a user-defined link that references an object by address is deleted. In general, H5O_INCR_REFCOUNT will have been used previously, when the link was created.
An object’s reference count is the number of hard links in the file that point to that object. See the “Programming Model” section of the HDF5 Groups chapter in the HDF5 User’s Guide for a more complete discussion of reference counts.
If a user application needs to determine an object’s reference count, an H5O_GET_INFO call is required; the reference count is returned in the rc field of the H5O_info_t struct.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Example:
History:
| Release | Change |
|---|
| 1.8.11 | Fortran subroutine introduced in this release. |
| 1.8.0 | Function introduced in this release. |
--- Last Modified: April 25, 2019 | 01:17 PM
