graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQCID - Inquire List of Color Table Identifiers

GPQCID (wsid, start, number, errind, totnum, ctid)

Note:

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

Purpose

Use GPQCID to inquire the list of color table identifiers existing on the specified workstation.

Color table identifiers that may exist on a workstation include: -1=DISPLAY_COLOR_TABLE, 0=RENDERING_COLOR_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 error indicator is 543 (the start value exceeds the extent of the available data), then only the total number (totnum) parameter is set. 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.

start -- specified by user, fullword integer

Starting member of the list of existing color tables (>=1)

number -- specified by user, fullword integer

Number of color table identifiers requested (>=0)

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
538: START VALUE < ONE
539: REQUESTED NUMBER < ZERO
543: START EXCEEDS DATA EXTENT. TOTAL NUMBER AVAILABLE RETURNED

totnum -- returned by the graPHIGS API, fullword integer

Total number of color tables on the workstation.

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

List of color table identifiers.

Error Codes

None

Related Subroutines

GPDFI: Define Image
GPXCR: Set Extended Color Representation

RCP code

201339145 (X'0C003109')