error_$c_text(3)

NAME

error_$c_text − return an error message for a status code

SYNOPSIS

C Syntax

char *error_$c_text(

status_$t status,
char *message,
int messagemax)

Pascal Syntax

procedure error_$c_text(

in status: status_$t;
out message: univ char;
in messagemax: integer32);

Remarks

To view this manual entry via the man(1) command, use the function name shown above without the “$” character.

DESCRIPTION

error_$c_text returns a null-terminated error message for reporting the completion status of a call. The error message is composed from predefined text strings that describe the subsystem, the module, and the error represented by the status code.

status A status code in status_$t format.

message
A character string. The error message represented by the status code.

messagemax
The maximum number of bytes to be returned in message.

EXAMPLE

The following statement returns an error message for reporting the status code st:

error_$c_text (st, message, MAX);

Museum