graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQITS - Inquire Input Device Trigger State

GPQITS (wsid, class, devnum, listid, start, number, errind, ntrigs, ltrigs)

Note:

This subroutine is a Workstation State List (WSL) inquiry. For an overview, see "WSL Inquiries"

Purpose

Use GPQITS to inquire the current trigger list for a specified level of a particular device on a specified workstation.

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.

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)

listid -- specified by user, fullword integer

Trigger list identifier for return of trigger list (>=0)

Trigger list identifier zero is always present and is called the primary trigger. The primary trigger causes the input to be returned to the application.

Secondary triggers may have different intermediate functions used in the processing of the input. They are identified with trigger list identifiers beginning with 1.

start -- specified by user, fullword integer

Starting member in the list of current triggers (>=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:

25: SPECIFIED WORKSTATION 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

ntrigs -- returned by the graPHIGS API, fullword integer

Number of triggers in the current trigger list.

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 3 fullword integers designating the trigger type, low trigger qualifier, and high trigger qualifier. The trigger type field has the following meanings:

Type	Meaning
`-1`	Change of the measure of the corresponding physical input device. The low qualifier specifies the granularity of movement which causes the trigger to fire. The granularity is specified as the amount that the physical device measure must change since the last trigger was fired in order for the trigger to be fired again. The high qualifier will be zero.
`0`	An implementation dependent trigger that is only valid as the default value.
`>0`	Physical device number within the button category. The trigger qualifiers for this trigger type are a range of choices on the indicated physical device.

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

RCP code

201338889 (X'0C003009')