graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQWTN - Inquire List of Available Workstation Types on Nucleus

GPQWTN (ncid, start, number, errind, maxa, totnum, wstype)

Note:

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

Purpose

Use GPQWTN to inquire a list of available generic workstation types on 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 generic workstation types (>=1)

number -- specified by user, fullword integer

Number of generic workstation types 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

maxa -- returned by the graPHIGS API, fullword integer

Maximum number of workstations to which a structure store can be simultaneously associated.

totnum -- returned by the graPHIGS API, fullword integer

Total number of available generic workstation types.

wstype -- returned by the graPHIGS API, array of 8-byte character strings

A list of generic workstation types available on the specified nucleus. The output array must be large enough to contain the requested data.

Error Codes

None

Related Subroutines

GPCRWS: Create Workstation

RCP code

201336332 ( X'0C00260C')