Retrieves the name of a compound or enumeration datatype member
Procedure:
H5T_GET_MEMBER_NAME (dtype_id, field_idx)
Signature:
char * H5Tget_member_name( hid_t dtype_id, unsigned field_idx )
SUBROUTINE h5tget_member_name_f(type_id,index, member_name, namelen, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(IN) :: index ! Field index (0-based) of
! the field name to retrieve
CHARACTER(LEN=*), INTENT(OUT) :: member_name ! Name of a field of
! a compound datatype
INTEGER, INTENT(OUT) :: namelen ! Length of the name
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tget_member_name_f
Parameters:
hid_t tdype_id | IN: Identifier of datatype to query |
unsigned field_idx | IN: Zero-based index of the field or element whose name is to be retrieved |
Description:
H5T_GET_MEMBER_NAME retrieves the name of a field of a compound datatype or an element of an enumeration datatype.
The index of the target field or element is specified in field_idx. Compound datatype fields and enumeration datatype elements are stored in no particular order with index values of 0 through N-1, where N is the value returned by H5T_GET_NMEMBERS.
The HDF5 library allocates a buffer to receive the name of the field. The caller must subsequently free the buffer with H5_FREE_MEMORY.
Returns:
Returns a valid pointer to a string allocated with malloc() if successful; otherwise returns NULL.
Example:
History:
| Release | Change |
|---|
| 1.6.4 | field_idx parameter type changed to unsigned. |
--- Last Modified: May 16, 2019 | 09:43 AM
