graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQEMS - Inquire Error Message

GPQEMS (length, errind, number, message)

Note:

This subroutine is a graPHIGS API State List (PSL) inquiry. For an overview, see "PSL Inquiries"

Purpose

Use GPQEMS to inquire the current error message. If an error was generated, the graPHIGS API returns the number of bytes in the error message and the error message text.

If the inquired information is available, the error indicator is returned as zero, and the values are returned in the output parameters. If the error indicator indicates that an output parameter is not large enough for the requested data, then the values will be available up to the length specified. If the inquired information is unavailable, the error indicator contains an error number indicating the reason, and the values returned in the output parameters are unpredictable.

Parameters

length -- specified by user, fullword integer

Length of error message array in bytes provided by the application for the graPHIGS API to return message.

errind -- returned by the graPHIGS API, fullword integer

Error indicator. If the error indicator is zero, the request has been completed. Otherwise, one of the following errors exists:

505: LENGTH OF RETURN ARRAY < ZERO
521: NOT IN ERROR STATE

number -- returned by the graPHIGS API, fullword integer

Total number of bytes in error message text.

message -- returned by the graPHIGS API, variable length character string

Message text.

Error Codes

None

Related Subroutines

None

RCP code

201337859 (X'0C002C03')