graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQNSP - Inquire Number of Structure Priorities Supported

GPQNSP (wstype, errind, npri)

Note:

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

Purpose

Use GPQNSP to inquire the number of the structure priorities supported for the specified workstation type.

When associating a structure to a view, the application specifies a structure priority, which is a real number between 0.0 and 1.0. The structures in each view are traversed in order, from lowest to highest priority.

The graPHIGS API returns values indicating the total number of supported structure priorities. For example, if a workstation uses a 4-bit mask to keep track of priorities, then it is able to support only 16 different priorities and must map the real number to one of 16 values. If a workstation can support a continuous range of structure priorities, then the inquiry returns a value of zero.

If the information is available, then the graPHIGS API sets the error indicator to zero and returns the values in the output parameter. If the inquired information is unavailable, then the error indicator (errind) contains the error number indicating the reason, and the values returned in the output parameter are unpredictable.

Parameters

wstype -- specified by user, 8-byte character string

Workstation type.

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:

23: SPECIFIED WORKSTATION TYPE DOES NOT EXIST
35: WORKSTATION HAS ONLY INPUT CAPABILITIES
548: SPECIFIED WORKSTATION TYPE CANNOT BE LOADED

npri -- returned by the graPHIGS API, fullword integer

Number of structure priorities supported. The value zero indicates that the workstation supports a continuous range of structure priorities.

Error Codes

None

Related Subroutines

GPARV: Associate Root with View
GPQRCT: Inquire Realized Connection Type

RCP code

201339397 (X'0C003205')