graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQES - Inquire List of Available Escape Subroutines

GPQES (wstype, start, number, errind, totnum, escid)

Note:

This subroutine is a Workstation Description Table (WDT) inquiry. For an overview, see "WDT Inquiries"

Purpose

Use GPQES to obtain a list of the escape function identifiers for the specified workstation type.

If the information is available, then the graPHIGS API sets the error indicator to zero and returns the values in the output parameter. 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 the error number indicating the reason, and the values returned in the output parameter are unpredictable.

Parameters

wstype -- specified by user, 8-byte character string

Workstation type.

start -- specified by user, fullword integer

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

number -- specified by user, fullword integer

Total number of escape subroutine 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:

23: SPECIFIED WORKSTATION TYPE DOES NOT EXIST
538: START VALUE < ONE
539: REQUESTED NUMBER < ZERO
543: START EXCEEDS DATA EXTENT. TOTAL NUMBER AVAILABLE RETURNED
548: SPECIFIED WORKSTATION TYPE CANNOT BE LOADED

totnum -- returned by the graPHIGS API, fullword integer

Total number of available escape subroutine identifiers.

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

List of available escape subroutine identifiers:

1001 - Sound Alarm
1002 - Enable/Disable Link Switch Notification
1003 - 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

GPQRCT: Inquire Realized Connection Type

RCP code

201340167 (X'0C003507')