Previous: nc_inq_enum_member, Up: User Defined Data Types


5.34 Learn the Name of a Enum Type: nc_inq_enum_ident

Get the name which is associated with an enum member value.

Usage

     int nc_inq_enum_ident(int ncid, nc_type xtype, long long value, char *identifier);
ncid
The groupid where this enum type exists.
xtype
The typeid for this enum type.
value
The value for which an identifier is sought.
identifier
If non-NULL, a pointer to an already allocated char array which will get the identifier, as a null terminated string. It will have a maximum length of NC_MAX_NAME+1.

Return Code

NC_NOERR
No error.
NC_EBADTYPEID
Bad type id, or not an enum type.
NC_EHDFERR
An error was reported by the HDF5 layer.
NC_EINVAL
The value was not found in the enum.

Example

See the example section for nc_inq_enum for a full example.