Returns the value of an enumeration datatype member

Procedure:

H5T_GET_MEMBER_VALUE (dtype_id, memb_no, value)

Signature:

<pre><code class="language-c">herr_t H5Tget_member_value( hid_t dtype_id, unsigned memb_no, void *value )</code></pre>

<pre><code class="language-fortran">SUBROUTINE h5tget_member_value_f(type_id,  member_no, value, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier 
  INTEGER, INTENT(IN) :: member_no      ! Number of the enumeration 
                                        ! datatype member
  INTEGER, INTENT(OUT) :: value         ! Value of the enumeration datatype
  INTEGER, INTENT(OUT) :: hdferr        ! Error code
END SUBROUTINE h5tget_member_value_f</code></pre>

Parameters:
hid_t dtype_idIN: Datatype identifier for the enumeration datatype
unsigned memb_no    IN: Number of the enumeration datatype member
void *valueOUT: Pointer to a buffer for output of the value of the enumeration datatype member

Description:

 H5T_GET_MEMBER_VALUE returns the value of the enumeration datatype member memb_no.

The member value is returned in a user-supplied buffer pointed to by value. Values returned in value will be of the enumerated type’s base type, that is, the datatype used by H5T_ENUM_CREATE  when the enumerated type was created.

The value buffer must be at least large enough to hold a value of that base type. If the size is unknown, you can determine it with H5T_GET_SIZE, H5Tget_size(dtype_id), where dtype_id is set to the base type.

Returns:

Returns a non-negative value if successful; otherwise returns a negative value.

Example:

Coming Soon!

History:
Release    Change
1.6.4membno parameter type changed to unsigned.