Page tree

The license could not be verified: License Certificate has expired!

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Content Layer
id1195548671
Content Column
width50.00001%
id1195578110
classrm_pagetree_col mobile-hide
Content Block
id1195578111
 
Content Column
width50.00001%
id1195548673
classhdf-rm-main-column
Content Block
id1195548672

Include Content
render-without-blockstrue
page.rm-navbar
HTML Wrap
classhdf-print-only

Page Title

HTML Wrap
classhdf-rm-summary-block

Hdf rm anchor
AnchorNamesummary

Excerpt

Returns a list of open object identifiers

HTML Wrap
classhdf-rm-content-block

Hdf rm anchor
AnchorNameprocedure

Procedure:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf_procedure

H5F_GET_OBJ_IDS (file_id, types, max_objs, obj_id_list)

Hdf rm anchor
AnchorNamesignature

Signature:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf-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_ids( hid_t file_id, unsigned int types, size_t max_objs, hid_t *obj_id_list )</code></pre>
HTML Wrap
classhdf-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_ids_f(file_id, obj_type, max_objs, obj_ids, hdferr, num_objs)

  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(IN)  :: max_objs ! Maximum number of object 
                                           ! identifiers to retrieve
  INTEGER(HID_T), DIMENSION(*), INTENT(OUT) :: obj_ids
                                           ! Array of requested object 
                                           ! identifiers
  INTEGER, INTENT(OUT)        :: hdferr    ! Error code 
                                           ! 0 on success and -1 on failure
  INTEGER(SIZE_T), INTENT(OUT), OPTIONAL :: num_objs 
                                           ! number of open objects of the specified type
END SUBROUTINE h5fget_obj_ids_f</code></pre>

Hdf rm anchor
AnchorNameparameters

Parameters:
HTML Wrap
classhdf-rm-section
hid_t file_idIN: Identifier of a currently-open HDF5 file or H5F_OBJ_ALL for all currently-open HDF5 files
unsigned int typesIN: Type of object for which identifiers are to be returned
size_t max_objsIN: Maximum number of object identifiers to place into obj_id_list
hid_t *obj_id_list    OUT: Pointer to the returned list of open object identifiers

Hdf rm anchor
AnchorNamedescription

Description:
HTML Wrap
classhdf-rm-section

Given the file identifier file_id and the type of objects to be identified, types, H5F_GET_OBJ_IDS returns the list of identifiers for all open HDF5 objects fitting the specified criteria.

To retrieve identifiers for open objects in all HDF5 application files that are currently open, pass the value H5F_OBJ_ALL in file_id.

The types of object identifiers to be retrieved are specified in types using the codes listed for the same parameter in H5F_GET_OBJ_COUNT.

To retrieve a count of open objects, use the H5F_GET_OBJ_COUNT function. This count can be used to set the max_objs parameter.

Hdf rm anchor
AnchorNamereturns

Returns:
HTML Wrap
classhdf-rm-section

Returns number of objects placed into obj_id_list if successful; otherwise returns a negative value.

Hdf rm anchor
AnchorNameexample

Example:
HTML Wrap
classhdf-rm-section

Coming soon!

Comment (Hide)
HTML Wrap
classhdf-togglebox hdf-c

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathexamples/h5_subset.c
showLineNumberstrue
lineStart32
progLangcpp
lineEnd42
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathfortran/examples/compound.f90
showLineNumberstrue
lineStart25
progLangplain
lineEnd35
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

Hdf rm anchor
AnchorNamehistory

History:
HTML Wrap
classhdf-rm-section
Release    Change
1.6.0C function introduced in this release.
1.6.8 &
    1.8.2
C function return type changed to ssize_t 
     and max_objs parameter datatype changed to size_t.