Name: H5Eget_msg
Signature:
ssize_t H5Eget_msg(hid_t mesg_id, H5E_type_t* mesg_type, char* mesg, size_t size)
Purpose:
Retrieves an error message.
Description:
H5Eget_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.
Parameters:
Returns:
Returns the size of the error message in bytes on success; otherwise returns a negative value.
Fortran90 Interface:
None.
History:
Release     C
1.8.0 Function introduced in this release.