Previous Scientific Data Formats: Hierarchical Data Format - HDF5 Next

H5T_ENUM_GET_DATA

Syntax | Return Value | Arguments | Keywords | Version History | See Also

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)

Return Value

Returns an array of IDL_H5_ENUM structures. 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

None

Version History

6.3
Introduced

See Also

H5T_ENUM_CREATE, H5T_ENUM_INSERT, H5T_ENUM_SET_DATA

  IDL Online Help (March 06, 2007)