H5F_GET_OBJ_COUNT

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
Returns the number of open object identifiers for an open file

HTML Wrap

class	hdf-rm-content-block

Hdf rm anchor

AnchorName	procedure

Procedure:

HTML Wrap

class	hdf-rm-section

HTML Wrap

class	hdf_procedure

H5F_GET_OBJ_COUNT (file_id, types)

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">ssize_t H5Fget_obj_count( hid_t file_id, unsigned int types )</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 h5fget_obj_count_f(file_id, obj_type, obj_count, hdferr)

  IMPLICIT NONE 
  INTEGER(HID_T), INTENT(IN)  :: file_id    ! File identifier
  INTEGER, INTENT(IN)         :: obj_type   ! Object types, possible values are:
                                            !     H5F_OBJ_FILE_F
                                            !     H5F_OBJ_GROUP_F
                                            !     H5F_OBJ_DATASET_F
                                            !     H5F_OBJ_DATATYPE_F
                                            !     H5F_OBJ_ALL_F
  INTEGER(SIZE_T), INTENT(OUT) :: obj_count ! Number of opened objects
  INTEGER, INTENT(OUT)         :: hdferr    ! Error code 
                                            ! 0 on success and -1 on failure
END SUBROUTINE h5fget_obj_count_f</code></pre>

Hdf rm anchor

AnchorName	parameters

Parameters:

HTML Wrap

class	hdf-rm-section

hid_t `file_id`	IN: Identifier of a currently-open HDF5 file or `H5F_OBJ_ALL` for all currently-open HDF5 files
unsigned int `types`	IN: Type of object for which identifiers are to be returned

Hdf rm anchor

AnchorName	description

Description:

HTML Wrap

class	hdf-rm-section

Given the identifier of an open file, file_id, and the desired object types, types, H5Fget H5F_obj_count returns GET_OBJ_COUNT returns the number of open object identifiers for the file.

To retrieve a count of open identifiers for open objects in all HDF5 application files that are currently open, pass the value (hid_t)H5F_OBJ_ALL (Fortran: INT(H5F_OBJ_ALL_F,HID_T)) in file_id.

The types of objects to be counted are specified in types as follows:

`H5F_OBJ_FILE`	Files only
`H5F_OBJ_DATASET`	Datasets only
`H5F_OBJ_GROUP`	Groups only
`H5F_OBJ_DATATYPE`	Named datatypes only
`H5F_OBJ_ATTR`	Attributes only
`H5F_OBJ_ALL`	All of the above (That is, `H5F_OBJ_FILE` `\|` `H5F_OBJ_DATASET` `\|` `H5F_OBJ_GROUP` `\|` `H5F_OBJ_DATATYPE` `\|` `H5F_OBJ_ATTR`)
`H5F_OBJ_LOCAL`	Restrict search to objects opened through current file identifier. Note: `H5F_OBJ_LOCAL` does not stand alone; it is effective only when used in combination with one or more of the preceding types. For example, `H5F_OBJ_DATASET` `\|` `H5F_OBJ_GROUP` `\|` `H5F_OBJ_LOCAL` would count all datasets and groups opened through the current file identifier.

Multiple object types can be combined with the logical OR operator (|). For example, the expression (H5F_OBJ_DATASET|H5F_OBJ_GROUP) would call for datasets and groups.

Hdf rm anchor

AnchorName	returns

Returns:

HTML Wrap

class	hdf-rm-section

Returns the number of open objects if successful; otherwise returns a negative value.

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

Release	Change
1.6.5	`H5F_OBJ_LOCAL` has been added as a qualifier on the types of objects to be counted. `H5F_OBJ_LOCAL` restricts the search to objects opened through current file identifier.
1.6.8 and 1.8.2	C function return type changed to `ssize_t`.

Page tree

Versions Compared

Old Version 3

New Version Current

Key

Procedure:

Signature:

Parameters:

Description:

Returns:

Example:

History:

The HDF Group

Site

Resources

Connect