graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQXCR - Inquire Extended Color Representation

GPQXCR (wsid, ctid, start, number, type, errind, color)

Note:

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

Purpose

Use GPQXCR to inquire the current color values in the specified color table of the specified workstation.

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.

ctid -- specified by user, fullword integer

Color table identifier of a color table that exists on the workstation (-1=DISPLAY_COLOR_TABLE, 0=RENDERING_COLOR_TABLE )

start -- specified by user, fullword integer

Index specifying an entry into the specified color table to start returning the requested color values (>=0)

number -- specified by user, fullword integer

Number of entries requested (>=0)

type -- specified by user, fullword integer

Type of returned values ( 1=SET )

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
284: COLOR TABLE IDENTIFIER DOES NOT EXIST
534: TYPE VALUE IS INVALID
539: REQUESTED NUMBER < ZERO
544: START VALUE < ZERO
551: START VALUE EXCEEDS COLOR TABLE SIZE
571: INQUIRED INFORMATION IS NOT AVAILABLE

color -- returned by the graPHIGS API, array of three short floating-point numbers

Array of color values ordered by row. The output array must be large enough to contain the requested data.

Error Codes

None

Related Subroutines

GPQCCH: Inquire Color Table Characteristics
GPQCID: Inquire List of Color Table Identifiers
GPXCR: Set Extended Color Representation

RCP code

201339153 ( X'0C003111')