H5T_IDLTYPE
Syntax | Return Value | Arguments | Keywords | Version History | See Also
The H5T_IDLTYPE function returns the IDL type code corresponding to a datatype.
Note
This function is not part of the standard HDF5 interface, but is provided as a programming convenience.
Syntax
Result = H5T_IDLTYPE(Datatype_id [, ARRAY_DIMENSIONS=variable][, STRUCTURE=variable] )
Return Value
The Result gives the IDL type code.
Note
For a list of IDL type codes and their definitions, see
"IDL Type Codes and Names" (IDL Reference Guide) under the SIZE function.
Arguments
Datatype_id
An integer giving the datatype identifier for which to return the IDL type code.
Keywords
ARRAY_DIMENSIONS
Set this keyword to a named variable in which to return a vector containing the array dimensions, if the datatype is an array. If the datatype is not an array, then a scalar value of 0 is returned.
STRUCTURE
Set this keyword to a named variable in which to return the IDL structure definition, if the datatype is a compound datatype. If the datatype is not compound, then a scalar value of 0 is returned.
Version History