[ Previous |
Next |
Contents |
Glossary |
Home |
Search ]
The graPHIGS Programming Interface : Subroutine Reference
GPQAIT - Inquire Actual Input Trigger Capabilities
| GPQAIT
(wsid,
class,
devnum,
start,
number,
errind,
ntrigs,
ltrigs) |
Purpose
Use
GPQAIT
to inquire the input device trigger capabilities of a
specified device on a given workstation.
If the triggers are programmable, a list of available triggers is
returned.
The returned list corresponds to the available triggers for
all triggers of the given input device.
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)
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:
- 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
- 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
The trigger qualifier fields are ignored.
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
- GPQIT
- Inquire Input Trigger Capabilities
- GPQRCT
- Inquire Realized Connection Type
RCP code
201336845
(X'0C00280D')
[ Previous |
Next |
Contents |
Glossary |
Home |
Search ]