You are viewing an old version of this page. View the current version.
Version 1 Next »
Increments an object reference count.
herr_t H5Oincr_refcount( hid_t object_id )
SUBROUTINE h5oincr_refcount_f(obj_id, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: obj_id INTEGER , INTENT(OUT) :: hdferr
|hid_t ||IN: Object identifier|
H5Oincr_refcount increments 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 added. When the link is deleted,
H5Odecr_refcount should be used.
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
H5Oget_info call is required; the reference count is returned in the
rc field of the
Warning: This function must be used with care!
Improper use can lead to inaccessible data, wasted space in the file, or file corruption.
Returns a non-negative value if successful; otherwise returns a negative value.
|1.8.11||Fortran subroutine introduced in this release.|
|1.8.0||Function introduced in this release.|