H5I: Identifier Interface

Identifier API Functions

The C Interface:

H5Iget_name

H5Iget_type

The FORTRAN90 Interfaces:
In general, each FORTRAN90 subroutine performs exactly the same task as the corresponding C function.

h5iget_name_f

h5iget_type_f

Name: H5Iget_name

Signature:

ssize_t H5Iget_name(hid_t obj_id, char *name, size_t size )

Purpose:

Retrieves a name of an object based on the object identifier.

Description:

H5Iget_name retrieves a name for the object identified by obj_id.

Up to size characters of the name are returned in name; additional characters, if any, are not returned to the user application.

If the length of the name, which determines the required value of size, is unknown, a preliminary H5Iget_name call can be made. The return value of this call will be the size of the object name. That value can then be assigned to size for a second H5Iget_name call, which will retrieve the actual name.

If there is no name associated with the object identifier or if the name is NULL, H5Iget_name returns 0 (zero).

Note that an object in an HDF5 file may have multiple names, varying according to the path through the HDF5 group hierarchy used to reach that object.

Parameters:

hid_t obj_id

IN: Identifier of the object. This identifier can refer to a group, dataset, or named datatype.

char *name

OUT: A name associated with the identifier.

size_t size

IN: The size of the name buffer.

Returns:

Returns the length of the name if successful, returning 0 (zero) if no name is associated with the identifier. Otherwise returns a negative value.

Fortran90 Interface: h5iget_name_f

SUBROUTINE h5iget_name_f(obj_id, buf, buf_size, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN)    :: obj_id     ! Object identifier 
  CHARACTER(LEN=*), INTENT(OUT) :: buf        ! Buffer to hold object name 
  INTEGER(SIZE_T), INTENT(IN)   :: buf_size   ! Buffer size
  INTEGER(SIZE_T), INTENT(OUT)  :: name_size  ! Name size
  INTEGER, INTENT(OUT) :: hdferr              ! Error code
                                              ! 0 on success, and -1 on failure
END SUBROUTINE h5iget_name_f
	

Name: H5Iget_type

Signature:

H5I_type_t H5Iget_type(hid_t obj_id)

Purpose:

Retrieves the type of an object.

Description:

H5Iget_type retrieves the type of the object identified by obj_id.

Valid types returned by the function are

H5I_FILE	File
H5I_GROUP	Group
H5I_DATATYPE	Datatype
H5I_DATASPACE	Dataspace
H5I_DATASET	Dataset
H5I_ATTR	Attribute

If no valid type can be determined or the identifier submitted is invalid, the function returns

H5I_BADID

Invalid identifier

This function is of particular value in determining the type of object closing function (H5Dclose, H5Gclose, etc.) to call after a call to H5Rdereference.

Parameters:

hid_t obj_id

IN: Object identifier whose type is to be determined.

Returns:

Returns the object type if successful; otherwise H5I_BADID.

Fortran90 Interface: h5iget_type_f

SUBROUTINE h5iget_type_f(obj_id, type, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: obj_id  !Object identifier 
  INTEGER, INTENT(OUT) :: type          !type of an object. 
                                        !possible values are:
                                        !H5I_FILE_F(1)
                                        !H5I_GROUP_F(2)
                                        !H5I_DATATYPE_F(3)
                                        !H5I_DATASPACE_F(4)
                                        !H5I_DATASET_F(5)
                                        !H5I_ATTR_F(6)
                                        !H5I_BADID_F(-1)
  INTEGER, INTENT(OUT) :: hdferr        ! E rror code
                                        ! 0 on success, and -1 on failure
END SUBROUTINE h5iget_type_f