H5T_ENUM_GET

H5T_ENUM_GET_DATA

The H5T_ENUM_GET_DATA function retrieves the name/value pairs from an enumeration datatype object.

This routine is written in the IDL language. Its source code can be found in the file h5t_enum_get_data.pro in the lib subdirectory of the IDL distribution.

Syntax

Result = H5T_ENUM_GET_DATA(Datatype_id [, /TYPE] )

Return Value

Returns a structure array. Each structure has two fields:

Name	A string containing the name of the member
Value	The value of the corresponding member

Arguments

Datatype_id

A long integer containing the identifier of the enumeration datatype for which the data is desired.

Keywords

TYPE

By default, H5T_ENUM_GET_DATA returned an array of named structures, with the name IDL_H5_ENUM. In that case, the value of each enumeration value is always converted to type long (32-bit) integer. If the TYPE keyword is set, then instead, return an anonymous structure containing the NAME and VALUE fields, where the VALUE field has the actual integer type for the enumeration datatype.

Version History

6.3	Introduced
8.6.1	Added TYPE keyword.