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

GPQID - Inquire Input Device State

GPQID (wsid, class, device, errind, state, deact, echosw, trigger, break, reset)

Note:

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

Purpose

Use GPQID to inquire the current operating mode of the specified logical input device.

The operating mode consists of six individual switches. With the Set Input Device Mode (GPIDMO) subroutine, your application can set each of these switches individually to a specified value. This subroutine returns the current value for each of the switches.

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 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 )

device -- specified by user, fullword integer

Logical input device number (>=1)

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
37
WORKSTATION IS NOT OF CATEGORY OUTIN
38
WORKSTATION HAS ONLY OUTPUT CAPABILITIES
140
DEVICE NUMBER < ONE OR DEVICE NOT AVAILABLE
328
INPUT CLASS VALUE IS INVALID

state -- returned by the graPHIGS API, fullword integer

State switch (1=DEVICE_INACTIVE, 2=DEVICE_ACTIVE )

deact -- returned by the graPHIGS API, fullword integer

Auto deactivate switch (1=OFF, 2=ON )

echosw -- returned by the graPHIGS API, fullword integer

Current echo switch (1=NOECHO, 2=ECHO )

trigger -- returned by the graPHIGS API, fullword integer

Primary trigger switch (1=OFF, 2=ON )

break -- returned by the graPHIGS API, fullword integer

Break switch (1=OFF, 2=ON )

reset -- returned by the graPHIGS API, fullword integer

Auto reset switch (1=OFF, 2=ON )

Error Codes

None

Related Subroutines

GPIDMO
Set Input Device Mode

RCP code

201338890 (X'0C00300A')


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