Retrieves an error message
Procedure:
H5E_GET_MSG(mesg_id, mesg_type, mesg, size)
Signature:
ssize_t H5Eget_msg(hid_t mesg_id, H5E_type_t* mesg_type, char* mesg, size_t size)
Parameters:
hid_t mesg_id | IN: Identifier for error message to be queried |
H5E_type_t* mesg_type | OUT: The type of the error message
Valid values are H5E_MAJOR and H5E_MINOR. |
char* mesg | OUT: Error message buffer |
size_t size | IN: The length of error message to be returned by this function |
Description:
H5E_GET_MSG retrieves the error message including its length and type. The error message is specified by mesg_id. User is responsible for passing in enough buffer for the message. If mesg is not NULL and size is greater than zero, the error message of size long is returned. The length of the message is also returned. If NULL is passed in as mesg, only the length and type of the message is returned. If the return value is zero, it means no message.
Returns:
Returns the size of the error message in bytes on success; otherwise returns a negative value.
Example:
History:
| Release | Change |
|---|
| 1.8.0 | Function introduced in this release. |
--- Last Modified: June 02, 2020 | 11:33 AM
