graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQXIR - Inquire Extended Interior Representation

GPQXIR (wsid, index, type, number, ids, errind, data)

Note:

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

Purpose

Use GPQXIR to inquire the current values of one or more fields in the specified interior bundle table entry of the specified workstation's interior bundle 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. The output parameter must be large enough to store all requested data. 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

Interior bundle table index (>=1)

type -- specified by user, fullword integer

Type of returned value ( 1=SET )

number -- specified by user, fullword integer

Number of group identifiers requested (>=1)

ids -- specified by user, array of fullword integers

A list of group identifiers.

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
43: BUNDLE INDEX EXCEEDS WORKSTATION TABLE CAPACITY
60: BUNDLE INDEX VALUE < ONE
272: GROUP IDENTIFIER IS INVALID
273: NUMBER OF GROUP IDENTIFIERS < ONE
534: TYPE VALUE IS INVALID

data -- returned by the graPHIGS API, variable data

Data array containing the values in the requested groups.

The value that may be set for each field is expressed in the data format listed below:

Group Identifier 1 - Interior style

A fullword integer ( 1=HOLLOW, 2=SOLID, 3=PATTERN, 4=HATCH, 5=EMPTY )

Group Identifier 2 - Interior style index

A fullword integer (>=1)

Group Identifier 3 - Interior color

Four fullwords of data with either of the following two formats:

 
 
       <----- width ------>  
      
      ---------------------- <--- top line
      |                    |
      |                    |
      |- - - - - - - - - - | <--- cap line
      |                    |   ^  
      |                    |   | height
      |                    |   |
      |                    |   |  
      |                    |   v         
      | - - - - - - - - - -| <--- base line
      |                    |
      |                    |
      ---------------------- <--- bottom line

Error Codes

None

Related Subroutines

GPXIR: Set Extended Interior Representation

RCP code

201339155 ( X'0C003113')