graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQPAR - Inquire Pattern Representation

GPQPAR (wsid, index, type, maxrow, maxcol, errind, drow, dcol, array)

Note:

This subroutine is a Workstation State List (WSL) inquiry. For an overview, see "WSL Inquiries"

Purpose

Use GPQPAR to inquire the current pattern representation in the specified entry in the pattern table of the specified workstation. This includes the pattern array row dimensions (drow), the column dimensions (dcol), and the pattern array (array) for the requested table entry.

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

index -- specified by user, fullword integer

Pattern table index (>=1)

type -- specified by user, fullword integer

Type of returned values (1=SET )

maxrow -- specified by user, fullword integer

Maximum number of rows to be returned by the graPHIGS API

maxcol -- specified by user, fullword integer

Maximum number of columns to be returned by the graPHIGS API

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
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
534: TYPE VALUE IS INVALID

drow -- returned by the graPHIGS API, fullword integer

Pattern array row dimension (number of rows)

dcol -- returned by the graPHIGS API, fullword integer

Pattern array column dimension (number of columns) 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 one. 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, the unused elements contain unpredictable values.

Error Codes

None

Related Subroutines

GPPAR: Set Pattern Representation

RCP code

201339142 (X'0C003106')