graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQIT - Inquire Input Trigger Capabilities

GPQIT (wstype, class, devnum, start, number, errind, ntrigs, ltrigs)

Note:

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

Purpose

Use GPQIT to inquire the input device trigger capabilities of a specified device for a specified workstation type. If the triggers are programmable, the graPHIGS API returns a list of available triggers. The returned list corresponds to the available triggers for all trigger levels of the specified input device.

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 identifier.

class -- specified by user, fullword integer

Input device class (1=LOCATOR, 2=STROKE, 3=VALUATOR, 4=CHOICE, 5=PICK, 6=STRING )

devnum -- specified by user, fullword integer

Input device number (>=1)

start -- specified by user, fullword integer

Starting member in the list of available trigger types (>=1)

number -- specified by user, fullword integer

Number of triggers requested from the list (>=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
140: DEVICE NUMBER < ONE OR DEVICE NOT AVAILABLE
328: INPUT CLASS VALUE IS INVALID
538: START VALUE < ONE
539: REQUESTED NUMBER < ZERO
543: START EXCEEDS DATA EXTENT. TOTAL NUMBER AVAILABLE RETURNED
548: SPECIFIED WORKSTATION TYPE CANNOT BE LOADED
569: DEVICE DOES NOT SUPPORT PROGRAMMABLE TRIGGERS

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 trigger descriptor triplets. The list is an array of trigger descriptors in which each descriptor consists of three fullword integers designating the trigger type, low trigger qualifier, and high trigger qualifier. The trigger type field has the following meanings:

Type	Meaning
>0	Identifier of physical device within the button category. The trigger qualifiers for this trigger type are a range of choice numbers generated by the physical device.
-1	Change of the measure of the logical input device Ignore the trigger qualifier fields.
-2	The secondary trigger fires when the primary trigger fires. This type is valid only for secondary (>0) trigger list identifier. Ignore the trigger qualifier fields.

The parameter ntrigs identifies the total number of triplets in the available trigger list. The actual number returned will depend on the setting of the start and number parameters.

Error Codes

None

Related Subroutines

GPIT: Set Input Device Trigger
GPQDIT: Inquire Default Input Device Triggers
GPQRCT: Inquire Realized Connection Type

RCP code

201339400 (X'0C003208')