[ Previous | Next | Contents | Glossary | Home | Search ]
The graPHIGS Programming Interface : Subroutine Reference

GPGTMS - Get Message

GPGTMS (ilen, olen, string)

Purpose

Use GPGTMS to retrieve a message string from the current event report. The event is not removed from the current event report until the next invocation of the Await Event (GPAWEV) subroutine.

Parameters

ilen -- specified by user, fullword integer

Length of the message to be returned in bytes. This value specifies the size of array provided in the string parameter. If the message length in the current event report is longer than this length, the overage is truncated.

olen -- returned by the graPHIGS API, fullword integer

Length of the message actually returned in bytes.

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

A character string supplied by the sender.

Error Codes

150
GET FUNCTION DOES NOT MATCH CURRENT EVENT CLASS
505
LENGTH OF RETURN ARRAY < ZERO
519
NO CURRENT EVENT REPORT AVAILABLE

Related Subroutines

GPAWEV
Await Event
GPSBMS
Send Broadcast Message
GPSPMS
Send Private Message

RCP code

201336072 (X'0C002508')

[ Previous | Next | Contents | Glossary | Home | Search ]