graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQBK - Inquire Break Capabilities

GPQBK (wstype, start, number, errind, ntrigs, ltrigs)

Note:

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

Purpose

Use GPQBK to inquire the break action capabilities for the specified workstation type. If the break action is programmable, the available triggers are returned.

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 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 available triggers (>=1)

number -- specified by user, fullword integer

Number of trigger list entries 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
38: WORKSTATION HAS ONLY OUTPUT 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
572: WORKSTATION DOES NOT SUPPORT PROGRAMMABLE BREAK ACTION

ntrigs -- returned by the graPHIGS API, fullword integer

Number of entries in the available triggers list.

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

List of available triggers (positive integers are button device numbers) The list is an array of trigger descriptors in which a descriptor consists of a triplet (3 fullword integers) containing the trigger type, low trigger qualifier, and high trigger qualifier. Positive integers as trigger types are button device numbers. The trigger qualifier for a choice device is the choice number. The parameter ntrigs identifies the total number of triplets in the available trigger list. The actual number returned depends on the setting of the start and number parameters.

Error Codes

None

Related Subroutines

GPBKAC: Set Break Action
GPQRCT: Inquire Realized Connection Type

RCP code

201339664 (X'0C003310')