graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQHR - Inquire Hatch Representation

GPQHR (wsid, index, errind, format, length, data)

Note:

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

Purpose

Use GPQHR to inquire the current hatch pattern in the specified entry of the workstation's hatch table.

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

Hatch table index (>=1)

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
84: INTERIOR STYLE INDEX VALUE < ONE
274: THIS FUNCTION IS NOT SUPPORTED BY THE WORKSTATION

format -- returned by the graPHIGS API, fullword integer

Hatch pattern format (1=BIT_ARRAY )

length -- returned by the graPHIGS API, fullword integer

Length of the hatch pattern definition.

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

Hatch pattern definition data. Values returned to this parameter depend on the hatch pattern format. The application must supply storage for this parameter that is large enough to contain the maximum data that the specified workstation supports (see the Inquire Hatch Facilities [GPQHF] [page GPQHF - Inquire Hatch Facilities]) subroutine.

1=BIT ARRAY

   
     -----------------
   0 |        x-size | fullword integer (number of columns)
     |---------------|
   4 |        y-size | fullword integer (number of rows)
     |---------------|
   8 |       pattern | bit array (array of unsigned characters)
     |               |
     -----------------

Note: The bit array will be in row order with each row beginning on a byte boundary. Therefore, the size of the bit array will be

((x-size + 7)/8 * y-size ) bytes.

Error Codes

None

Related Subroutines

GPHR: Set Hatch Representation
GPIS: Set Interior Style
GPISI: Set Interior Style Index
GPXIR: Set Extended Interior Representation

RCP code

201339149 (X'0C00310D')