Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5G_OPEN2

Opens an existing group with a group access property list

Procedure:

H5G_OPEN2(loc_id, name, gapl_id)

Signature:

hid_t H5Gopen2( hid_t loc_id, const char * name, hid_t gapl_id )

SUBROUTINE h5gopen_f(loc_id, name, grp_id, hdferr, gapl_id)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier 
  CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the group 
  INTEGER(HID_T), INTENT(OUT) :: grp_id  ! File identifier 
  INTEGER, INTENT(OUT) :: hdferr         ! Error code  
                                         ! 0 on success and -1 on failure
  INTEGER(HID_T), OPTIONAL, INTENT(IN) :: gapl_id  
                                         ! Group access property list identifier
END SUBROUTINE h5gopen_f

Parameters:
hid_t loc_idIN: File, group, dataset, named datatype or attribute identifier specifying the location of the group to be opened
const char *name    IN: Name of the group to open
hid_t gapl_idIN: Group access property list identifier 
(No group access properties have been implemented at this time; use H5P_DEFAULT.)

Description:

H5G_OPEN2 opens an existing group, name, at the location specified by loc_id.

With default settings, H5G_OPEN2 provides similar functionality to that provided by H5G_OPEN1. The only difference is that H5G_OPEN2 can provide a group access property list, gapl_id.

H5G_OPEN2 returns a group identifier for the group that was opened. This group identifier should be released by calling H5G_CLOSE when it is no longer needed.

Returns:

Returns a group identifier if successful; otherwise returns a negative value. 

Example:

Coming soon!

 

History:
Release    Change
1.8.0Function introduced in this release.

--- Last Modified: July 29, 2020 | 12:44 PM