graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQICH - Inquire Image Characteristics

GPQICH (wsid, index, errind, conn, ctid, totnum, libid)

Note:

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

Purpose

Use GPQICH to inquire the current image characteristics of the specified image on the specified workstation. The specified image was created by the Define Image (GPDFI) subroutine. Its characteristics consist of the image boards and color tables that are grouped together to form the specified image.

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.

The list of image board identifiers parameter (libid) must have a length of at least three fullwords.

Parameters

wsid -- specified by user, fullword integer

Workstation identifier.

index -- specified by user, fullword integer

Defined image 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
216: ONE OR MORE RESOURCES IS NOT ATTACHED
290: SPECIFIED IMAGE INDEX IS NOT DEFINED

conn -- returned by the graPHIGS API, fullword integer

Connection type (-1=FRAME_BUFFER_COMPATIBLE, 1=COMPONENT, 2=INDEXED )

ctid -- returned by the graPHIGS API, fullword integer

Color table identifier of the color table used to form the specified image.

totnum -- returned by the graPHIGS API, fullword integer

Number of image boards grouped together to form the specified image.

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

List of image board identifiers that form the specified image.

The application must supply storage that is large enough to contain the maximum number of image board identifiers that the workstation supports. (Currently, three. However, in the future, this number may increase. Therefore, it is recommended that storage be supplied for at least 24 image board identifiers.)

Error Codes

None

Related Subroutines

GPCRIB: Create Image Board
GPDFI: Define Image

RCP code

201346561 (X'0C004E01')