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

GPQAIS - Inquire Actual Input Character Set Facilities

GPQAIS (wsid, class, device, start, number, errind, ncsid, csid)

Purpose

Use GPQAIS to inquire the actual input character sets that are available for a specified input device.

The values returned by the graPHIGS API indicate the total quantity of character sets available and their identifiers.

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 requested (1=LOCATOR, 2=STROKE, 3=VALUATOR, 4=CHOICE, 5=PICK, 6=STRING )

device -- specified by user, fullword integer

Device number.

start -- specified by user, fullword integer

Starting member of the list of character set identifiers (>=1)

number -- specified by user, fullword integer

Number of character set identifiers requested (>=0) Number refers to the number of csid values 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
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

ncsid -- returned by the graPHIGS API, fullword integer

Total number of character set identifiers.

csid -- returned by the graPHIGS API, array of fullword integers.

List of character set identifiers.

See Appendix A. "Character Set and Font Identifiers" for more information.

The output array must be large enough to contain the requested data.

Error Codes

None

Related Subroutines

GPQISF
Inquire Input Character Set Facilities
GPQRCT
Inquire Realized Connection Type

RCP code

201336592 (X'0C002710')


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