graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQALI - Inquire List of Actual Logical Input Devices

GPQALI (wsid, class, start, number, errind, ndev, dev)

Purpose

Use GPQALI to inquire the available input devices at the specified workstation.

For the specified device class, the graPHIGS API returns a number indicating the quantity of logical devices and their numbers for the 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

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

start -- specified by user, fullword integer

Starting member of the list of input devices (>=1)

number -- specified by user, fullword integer

Number of input device numbers requested (>=0) This refers to the total quantity of device numbers the graPHIGS API returns.

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
328: INPUT CLASS VALUE IS INVALID
538: START VALUE < ONE
539: REQUESTED NUMBER < ZERO
543: START EXCEEDS DATA EXTENT. TOTAL NUMBER AVAILABLE RETURNED

ndev -- returned by the graPHIGS API, fullword integer

Total quantity of logical devices in the device class.

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

List of device numbers in the device class. The output array must be large enough to contain the requested data.

Error Codes

None

Related Subroutines

GPQLI: Inquire List of Logical Input Devices
GPQRCT: Inquire Realized Connection Type

RCP code

201336580 (X'0C002704')