H5I_GET_FILE_ID

Content Layer

id	1195548671

Content Column

width	50.00001%
id	1195578110
class	rm_pagetree_col mobile-hide

Content Block

id	1195578111

Content Column

width	50.00001%
id	1195548673
class	hdf-rm-main-column

Content Block

id	1195548672

Include Content

render-without-blocks	true
page	.rm-navbar

HTML Wrap

class	hdf-print-only

Page Title

HTML Wrap

class	hdf-rm-summary-block

Hdf rm anchor

AnchorName	summary

Excerpt
Retrieves an identifier for the file containing the specified object

HTML Wrap

class	hdf-rm-content-block

Hdf rm anchor

AnchorName	procedure

Procedure:

HTML Wrap

class	hdf-rm-section

HTML Wrap

class	hdf_procedure

H5I_GET_FILE_ID(obj_id)

Hdf rm anchor

AnchorName	signature

Signature:

HTML Wrap

class	hdf-rm-section

HTML Wrap

class	hdf-togglebox hdf-c

HTML Add Class

	hdf-togglebutton-visible
	hdf-togglebutton-visible
selector	.hdf-togglebutton.hdf-c

HTML
<pre><code class="language-c">hid_t H5Iget_file_id( hid_t obj_id )</code></pre>

HTML Wrap

class	hdf-togglebox hdf-fortran hdf-togglebox-hidden

HTML Add Class

	hdf-togglebutton-visible
	hdf-togglebutton-visible
selector	.hdf-togglebutton.hdf-fortran

HTML

<pre><code class="language-fortran">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</code></pre>

Hdf rm anchor

AnchorName	parameters

Parameters:

HTML Wrap

class	hdf-rm-section

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

Hdf rm anchor

AnchorName	description

Description:

HTML Wrap

class	hdf-rm-section

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.

Hdf rm anchor

AnchorName	returns

Returns:

HTML Wrap

class	hdf-rm-section

Returns a file identifier on success, negative on failure.

Hdf rm anchor

AnchorName	example

Example:

HTML Wrap

class	hdf-rm-section

Coming soon!

Comment

HTML Wrap

class	hdf-togglebox hdf-c

Bitbucket Server file

repoSlug	hdf5
branchId	refs/heads/1.10/master
projectKey	HDFFV
filepath	examples/h5_subset.c
showLineNumbers	true
lineStart	32
progLang	cpp
lineEnd	42
applicationLink	5ac7b370-7412-3c8c-ad20-807a68261336

HTML Wrap

class	hdf-togglebox hdf-fortran hdf-togglebox-hidden

Bitbucket Server file

repoSlug	hdf5
branchId	refs/heads/1.10/master
projectKey	HDFFV
filepath	fortran/examples/compound.f90
showLineNumbers	true
lineStart	25
progLang	plain
lineEnd	35
applicationLink	5ac7b370-7412-3c8c-ad20-807a68261336

Hdf rm anchor

AnchorName	history

History:

HTML Wrap

class	hdf-rm-section

C

Release	Change
1.6.3	Function introduced in this release. Fortran subroutine introduced in this release.

Page tree

Versions Compared

Old Version 4

New Version Current

Key

Procedure:

Signature:

Parameters:

Description:

Returns:

Example:

History:

The HDF Group

Site

Resources

Connect