graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQWTO - Inquire Workstation Type and Options

GPQWTO (wsid, ilen, errind, wstype, olen, options)

Note:

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

Purpose

Use GPQWTO to inquire the generic workstation type and workstation creation options that were used to create the specified workstation ( wsid)

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 error indicator is 536 (the actual creation workstation options are greater than the length of the area provided), then only the actual length ( olen) of the options is returned. 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

wsid -- specified by user, fullword integer

Workstation identifier.

ilen -- specified by user, fullword integer

Length of the area provided to contain the creation workstation options.

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
536: INQUIRY DATA EXCEEDS AREA. LENGTH OF REQUIRED AREA RETURNED

wstype -- returned by the graPHIGS API, 8-byte character string

Generic workstation type.

olen -- returned by the graPHIGS API, fullword integer

Actual length of the creation workstation options. If the area provided is large enough to contain the options, then the graPHIGS API returns the actual length of the options in this field. This actual length is the same as the length provided in the first word of the options parameter. If the area provided is not large enough to contain the options, then olen contains the actual length required and the graPHIGS API sets the error indicator to error 536

options -- returned by the graPHIGS API, variable data

Workstation creation options. This parameter has the following format:

       --------------------
       | length of options| Fullword integer
       |------------------|
       | list of options  | Variable data
       Z                  Z
       |                  |
       --------------------

This format is the same format specified by the Create Workstation ( GPCRWS) subroutine. See GPCRWS - Create Workstation for this format.

Error Codes

None

Related Subroutines

GPCRWS: Create Workstation

RCP code

201336854 ( X'0C002816')