[ Previous | Next | Contents | Glossary | Home | Search ]
The graPHIGS Programming Interface : Subroutine Reference

GPQDIT - Inquire Default Input Device Triggers

GPQDIT (wstype, class, devnum, listid, start, number, errind, ndtrigs, dtriglist)

Note:

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

Purpose

Use GPQDIT to inquire the default trigger list of a specified input device 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.

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 default 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 subroutines used in the processing of the input. They are identified with trigger list identifiers beginning with the value one.

start -- specified by user, fullword integer

Starting member in the list of default triggers (>=1)

number -- specified by user, fullword integer

Number of triggers requested from the trigger 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
570
SPECIFIED TRIGGER LIST IDENTIFIER DOES NOT EXIST

ndtrigs -- returned by the graPHIGS API, fullword integer

Total number of triggers in the default trigger list.

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

List of default trigger descriptor triplets. 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 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 will depend on the setting of the start and number parameters.

Error Codes

None

Related Subroutines

GPIT
Set Input Device Trigger
GPQITS
Inquire Input Device Trigger State
GPQRCT
Inquire Realized Connection Type

RCP code

201339401 (X'0C003209')


[ Previous | Next | Contents | Glossary | Home | Search ]