graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQAES - Inquire List of Actual Available Escape Subroutines

GPQAES (wsid, start, number, errind, nids, idlist)

Purpose

Use GPQAES to inquire the list of escape subroutine identifiers supported by a given workstation.

If the inquired information is available, then the graPHIGS API sets the error indicator to zero and returns the values in the output parameters. If the error indicator is 543 (the start value exceeds the extent of the available data), then only the total number (totnum) parameter is set. If the inquired information is unavailable, then the error indicator (errind) contains an error number indicating the reason, and the values returned in the output parameters are unpredictable.

Parameters

wsid -- specified by user, fullword integer

Workstation identifier.

start -- specified by user, fullword integer

Starting member in the list of escape identifiers (>=1)

number -- specified by user, fullword integer

Number of escape identifiers requested (>=0)

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:

25: SPECIFIED WORKSTATION DOES NOT EXIST
538: START VALUE < ONE
539: REQUESTED NUMBER < ZERO
543: START EXCEEDS DATA EXTENT. TOTAL NUMBER AVAILABLE RETURNED

nids -- returned by the graPHIGS API, fullword integer

Total number of available escape identifiers.

idlist -- returned by the graPHIGS API, array of fullword integers

List of available escape identifiers

1001 = Sound Alarm
1002 = Enable/Disable Link Switch Notification
1003 = GDF/CGM Plot Size
1004 = Initialize Pick Correlation State
1005 = Set Pick Selection Criteria
1006 = Set Input Echo Color
1007 = Read Frame Buffer
1008 = Geometric Text Culling
1009 = Window Resize Notification Control
1010 = Inquire Mapped Display Surface Size
1011 = Window Exposure Notification Control
1012 = Window Deletion Notification Control
1014 = Workstation-Dependent Output
1015 = Convert Coordinate Values

Error Codes

None

Related Subroutines

GPQES: Inquire List of Available Escape Subroutines
GPQRCT: Inquire Realized Connection Type

RCP code

201340168 (X'0C003508')