graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQIDD - Inquire Input Device Description

GPQIDD (wstype, class, devnum, id, lidata, idata, mlodata, errind, lodata, odata)

Note:

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

Purpose

Use GPQIDD to inquire the information about the specified device.

The group identifier (id) parameter identifies the data the graPHIGS API returns. Some data types may require additional information in the input data (idata) parameter.

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 533 (an output parameter is not large enough for all the requested data), then the values up to the length specified are returned. If the information you inquired 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

Device number (>=1)

id -- specified by user, fullword integer

Group identifier. The graPHIGS API supports the following identifiers:

Group identifier 1

Available pick selection criteria. The device class must be set to a value of 5=PICK No input data is required for this identifier.

lidata -- specified by user, fullword integer

Length, in bytes, of the input data area (>=0)

idata -- variable length data

Input data. Depending on the id parameter value specified, input data is as follows:

If Group Identifier=1 (available pick selection criteria)

No input data is required for this identifier.

mlodata -- specified by user, fullword integer

Length, in bytes, of the output data area (>=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
272: GROUP IDENTIFIER IS INVALID
328: INPUT CLASS VALUE IS INVALID
509: DATA LENGTH VALUE < ZERO OR REQUIRED LENGTH
533: INQUIRY DATA EXCEEDS AREA. OUTPUT TRUNCATED
548: SPECIFIED WORKSTATION TYPE CANNOT BE LOADED

lodata -- returned by the graPHIGS API, fullword integer

Length, in bytes, of the available output data.

odata -- returned by the graPHIGS API, variable length data

Output data. Depending on the specified value of the id parameter, output data is as follows:

Group Identifier=1 (available pick selection criteria)

Array of fullword integers.

The available pick selection criteria. The lodata parameter specifies the length of the array in bytes (1=FIRST, 2=LAST, 3=ALL, 4=FIRST_VISIBLE, 5=LAST_VISIBLE, 6=ALL_VISIBLE )

Error Codes

None

Related Subroutines

GPPKSC: Set Pick Selection Criteria
GPQRCT: Inquire Realized Connection Type

RCP code

201339677 (X'0C00331D')