Retrieves error class name
Procedure:
H5E_GET_CLASS_NAME(class_id, name, size)
Signature:
ssize_t H5Eget_class_name(hid_t class_id, char* name, size_t size)
Parameters:
hid_t class_id | IN: Error class identifier |
char* name | OUT: The name of the class to be queried |
size_t size | IN: The length of the class name to be returned by this function |
Description:
H5E_GET_CLASS_NAME retrieves the name of the error class specified by the class identifier. If non-NULL pointer is passed in for name
and size
is greater than zero, the class name of size
long is returned. The length of the error class name is also returned. If NULL is passed in as name, only the length of class name is returned. If zero is returned, it means no name. User is responsible for allocated enough buffer for the name.
Returns:
Returns non-negative value as on success; otherwise returns negative value.
Example:
History:
Release | Change |
---|
1.8.0 | Function introduced in this release. |
--- Last Modified: May 26, 2020 | 01:07 PM