graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQIBF - Inquire Image Board Facilities

GPQIBF (ncid, start, number, errind, totnum, depth, h, v)

Note:

This subroutine is a Nucleus Description Table (NDT) inquiry. For an overview, see "NDT Inquiries"

Purpose

Use GPQIBF to inquire the image board capabilities for the specified nucleus.

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

ncid -- specified by user, fullword integer

Nucleus identifier.

start -- specified by user, fullword integer

Starting member in the list of available image board bit depth (>=1)

number -- specified by user, fullword integer

Number of image board bit depth entries 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:

202: SPECIFIED NUCLEUS DOES NOT EXIST
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 available image board bit depths.

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

List of available image board bit depths.

h -- returned by the graPHIGS API, fullword integer

Maximum horizontal size of an image board. (A value of zero means that there is no limit on the image board size.)

v -- returned by the graPHIGS API, fullword integer

Maximum vertical size of an image board. (A value of zero means that there is no limit on the image board size.)

Error Codes

None

Related Subroutines

GPCRIB: Create Image Board
GPFRCT: Fill Rectangle
GPRDFB: Read Frame Buffer
GPQIBC: Inquire Image Board Characteristics
GPWRCT: Write Rectangle

RCP code

201345801 (X'0C004B09')