Name

bstr_get_message − Gets the message associated with a status code. 

Syntax

bstr_t_status  bstr_get_message (
                                  bstr_t_status     code,
                                  bstr_t_string     text,
                                  bstr_t_natural16  max_len );

Description

  The bstr_get_message procedure returns the message associated with the specified status code. If the status code specified in the code argument is unknown, the procedure returns the string "NOMSG, No message" in the text argument. 

Arguments

code
access: read
The status code whose message is to be obtained.

text
access: write
The address of the location where the associated string is returned. If the status code specified in the code argument is  unknown, the "NOMSG, No message" string is returned. 

max_len
access: read
The length of the location allocated by the application to receive the message. An error is returned if the length of the message is greater than max_len. 

Return Values