graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQCUF - Inquire Cursor Facilities

GPQCUF (wstype, start1, num1, start2, num2, errind, maxent, maxsize, totnum1, lformat, totnum2, lcursor, npred)

Note:

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

Purpose

Use GPQCUF to inquire the cursor definition facilities for the specified workstation type.

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

start1 -- specified by user, fullword integer

Starting member of the list of available cursor definition formats (>=1)

num1 -- specified by user, fullword integer

Number of entries from the list of available cursor definition formats that are requested (>=0)

start2 -- specified by user, fullword integer

Starting member of the list of available fixed cursor types (>=1)

num2 -- specified by user, fullword integer

Number of entries from the list of available fixed cursor types that are requested (>=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
37: WORKSTATION IS NOT OF CATEGORY OUTIN
538: START VALUE < ONE
539: REQUESTED NUMBER < ZERO
543: START EXCEEDS DATA EXTENT. TOTAL NUMBER AVAILABLE RETURNED

maxent -- returned by the graPHIGS API, fullword integer

Maximum number of cursor shape table entries.

maxsize -- returned by the graPHIGS API, fullword integer

Maximum number of bytes that a cursor definition may occupy.

totnum1 -- returned by the graPHIGS API, fullword integer

Total number of available cursor definition formats.

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

List of available cursor definition formats. Each entry of this array consists of three integers. The first one will always be a format identifier. The meaning of the other two words is dependent on the value of the first word.

Format 1 -

Words 2 and 3 are the required x size and y size respectively of the pixel array which defines the cursor shape.

totnum2 -- returned by the graPHIGS API, fullword integer

Total number of available fixed cursor types.

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

List of available fixed cursor types.

Possible available fixed cursor types are:

-1=Cross hair cursor.

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

Number of predefined cursor shape table entries.

Error Codes

None

Related Subroutines

GPCUR: Set Cursor Representation
GPCUS: Set Cursor Shape
GPQRCT: Inquire Realized Connection Type

RCP code

201346061 (X'0C004C0D')