Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5I_GET_FILE_ID

Retrieves an identifier for the file containing the specified object

Procedure:

H5I_GET_FILE_ID(obj_id)

Signature:

hid_t H5Iget_file_id( hid_t obj_id )

SUBROUTINE h5iget_file_id_f(obj_id, file_id, hdferr) 

  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN)  :: obj_id     ! Object identifier 
  INTEGER(HID_T), INTENT(OUT) :: file_id    ! File identifier
  INTEGER, INTENT(OUT) :: hdferr            ! Error code

END SUBROUTINE h5iget_file_id_f

Parameters:
hid_t obj_id    IN: Identifier of the object whose associated file identifier will be returned; can be a file, group, dataset, named datatype or attribute identifier

Description:

H5I_GET_FILE_ID returns the identifier of the file associated with the object referenced by obj_id.

Note that the HDF5 library permits an application to close a file while objects within the file remain open. If the file containing the object obj_id is still open, H5I_GET_FILE_ID  will retrieve the existing file identifier. If there is no existing file identifier for the file, i.e., the file has been closed, H5I_GET_FILE_ID will reopen the file and return a new file identifier. In either case, the file identifier must eventually be released using H5F_CLOSE.

Returns:

Returns a file identifier on success, negative on failure.

Example:

Coming soon!

 

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

--- Last Modified: April 25, 2018 | 03:16 PM