graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQPPR - Inquire Predefined Pattern Representation

GPQPPR (wstype, index, maxrow, maxcol, errind, drow, dcol, array)

Note:

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

Purpose

Use GPQPPR to inquire a predefined pattern table entry for the specified workstation type.

For the specified workstation type, this inquiry returns the values corresponding to the specified index of the predefined pattern table. The graPHIGS API returns the number of pattern array rows (drow) and columns (dcol), and the array of color indexes corresponding to the pattern (array)

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

index -- specified by user, fullword integer

Pattern table index (>=1)

maxrow -- specified by user, fullword integer

Maximum number of requested pattern array rows (>=1)

maxcol -- specified by user, fullword integer

Maximum number of requested pattern array columns (>=1)

The parameters maxrow and maxcol define the dimensions of the application's output area array Using these values, the graPHIGS API either fills in or truncates the output information, as appropriate.

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
35: WORKSTATION HAS ONLY INPUT CAPABILITIES
48: PATTERN INDEX EXCEEDS WORKSTATION TABLE CAPACITY
85: PATTERN INDEX VALUE < ONE
90: INTERIOR STYLE NOT SUPPORTED ON WORKSTATION
91: STARTING POINT OR DIMENSION < ONE
533: INQUIRY DATA EXCEEDS AREA. OUTPUT TRUNCATED
548: SPECIFIED WORKSTATION TYPE CANNOT BE LOADED

drow -- returned by the graPHIGS API, fullword integer

Total number of pattern array rows in the entry specified.

dcol -- returned by the graPHIGS API, fullword integer

Total number of pattern array columns in the entry specified.

The output parameters drow and dcol identify the actual size of the requested pattern entry. Depending on the values of maxrow and maxcol, these may or may not match the amount of data actually placed in the output area.

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

Pattern array of color indexes in row order. The pattern array of color indexes is returned within the array bounds specified by maxrow and maxcol Each pattern row is returned in the corresponding row of array beginning in column 1. The high numbered rows and columns of the returned pattern are omitted as necessary to fit the number of rows and columns specified for array by maxrow and maxcol Error indicator 533 is set in this case. If either dimension of the pattern is smaller than the dimension of array, then the unused elements contain unpredictable values.

Error Codes

None

Related Subroutines

GPQRCT: Inquire Realized Connection Type

RCP code

201339910 (X'0C003406')