graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQGSE - Inquire List of Available GSEs

GPQGSE (wstype, start, number, errind, totnum, gseid)

Note:

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

Purpose

Use GPQGSE to inquire a list of GSE identifiers available 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 of the list of GSEs (>=1)

number -- specified by user, fullword integer

Number of GSE 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
35: WORKSTATION HAS ONLY INPUT CAPABILITIES
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 GSEs.

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

List of GSE identifiers. One or more of the following GSE identifiers may be returned:

1001 - Set Frame Buffer Protect Mask

1002 - Set Frame Buffer Comparison

1003 - Set Condition

1004 - Conditional Execute Structure

1005 - Conditional Return

1006 - Test Extent 3

1007 - Test Extent 2

1008 - Parametric Surface Characteristics

1009 - Z-buffer Protect Mask

1010 - Workstation-Dependent Output

Error Codes

None

Related Subroutines

GPQRCT: Inquire Realized Connection Type

RCP code

201339406 (X'0C00320E')