graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQABK - Inquire Actual Break Capabilities

GPQABK (wsid, start, number, errind, ntrigs, ltrigs)

Purpose

Use GPQABK to inquire the break action capabilities of the given workstation. A list of available triggers for a break action is 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 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 of the list of available triggers (>=1)

number -- specified by user, fullword integer

Number of triggers 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
38: WORKSTATION HAS ONLY OUTPUT CAPABILITIES
538: START VALUE < ONE
539: REQUESTED NUMBER < ZERO
543: START EXCEEDS DATA EXTENT. TOTAL NUMBER AVAILABLE RETURNED
572: WORKSTATION DOES NOT SUPPORT PROGRAMMABLE BREAK ACTION

ntrigs -- returned by the graPHIGS API, fullword integer

Total number of entries in the list of available triggers.

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

List of available triggers as specified by the start and number parameters. The list is an array of trigger descriptors, consisting of three fullword integers each, in which a descriptor consists of a triplet containing the trigger type, low trigger qualifier, and high trigger qualifier. Positive integers as trigger types are choice 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

GPQBK: Inquire Break Capabilities
GPQRCT: Inquire Realized Connection Type

RCP code

201336844 (X'0C00280C')