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

GPGTST - Get String

GPGTST (ilen, olen, string)

Purpose

Use GPGTST to retrieve a string input value 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.

The length of the returned string is less than, or equal to, the buffer size found in the string data record at the time the device was placed in event mode.

The device to which this value corresponds was identified on the previous invocation of GPAWEV

Parameters

ilen -- specified by user, fullword integer

Length of string array in bytes provided by application to return string data (>=0)

olen -- returned by the graPHIGS API, fullword integer

Length of the character string actually returned in bytes.

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

Character string.

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

RCP code

201336070 (X'0C002506')


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