Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5I_GET_REF

Retrieves the reference count for an object.

Procedure:

H5I_GET_REF(obj_id)

Signature:

int H5Iget_ref( hid_t obj_id )

SUBROUTINE h5iget_ref_f(obj_id, ref_count, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: obj_id  !Object identifier 
  INTEGER, INTENT(OUT) :: ref_count     !Reference count of object identifier
  INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                        ! 0 on success, and -1 on failure
END SUBROUTINE h5iget_ref_f

Parameters:
hid_t obj_id    IN: Object identifier whose reference count will be retrieved.

Description:

H5I_GET_REF retrieves the reference count of the object identified by obj_id.

The reference count for an object identifier is attached to the information about an object in memory and has no relation to the number of links to an object on disk.

The function H5I_IS_VALID is used to determine whether a specific object identifier is valid.

Returns:

Returns a non-negative current reference count of the object identifier if successful; otherwise a negative value is returned. 

Example:

Coming soon!

 

History:
Release    C
1.6.2Function introduced in this release.
Fortran subroutine introduced in this release.

--- Last Modified: January 08, 2018 | 02:21 PM