graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQIW - Inquire List of Images on the Workstation

GPQIW (wsid, start, number, errind, totnum, lindex)

Note:

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

Purpose

Use GPQIW to inquire the currently defined images on the specified workstation. Images were defined on the workstation by the Define Image (GPDFI) subroutine.

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 indexes of defined images (>=1)

number -- specified by user, fullword integer

Number of image indexes 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 defined images on the workstation.

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

List of image indexes for the defined images.

Error Codes

None

Related Subroutines

GPCAI: Cancel Image
GPDFI: Define Image

RCP code

201346566 (X'0C004E06')