Returns the value corresponding to a specified member of an enumeration datatype

Procedure:

H5T_ENUM_VALUEOF (dtype_id, name, value)

Signature:

<pre><code class="language-c">herr_t H5Tenum_valueof( hid_t dtype_id, char *name, void *value )</code></pre>

<pre><code class="language-fortran">SUBROUTINE h5tenum_valueof_f(type_id,  name, value, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier 
  CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of the enumeration datatype
  INTEGER, INTENT(OUT) :: value         ! Value of the enumeration datatype
  INTEGER, INTENT(OUT) :: hdferr        ! Error code
END SUBROUTINE h5tenum_valueof_f</code></pre>

Parameters:
hid_t dtype_idIN: Enumeration datatype identifier
const char *name    IN: Symbol name of the enumeration datatype
void *valueOUT: Buffer for output of the value of the enumeration datatype

Description:

H5T_ENUM_VALUEOF finds the value that corresponds to the specified name of the enumeration datatype dtype_id.

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!