graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQDLC - Inquire Default Locator Device Data

GPQDLC (wstype, device, start, number, length, errind, dimen, pos, necho, echo, area, datalen, data)

Note:

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

Purpose

Use GPQDLC to inquire the default value of the requested locator device for the specified workstation type.

The graPHIGS API returns the default values for the requested locator device. The default initial locator position is in view zero, which is the only active view by default. For more information on the defaults, see The graPHIGS Programming Interface: Technical Reference

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 533 (an output parameter is not large enough for all the requested data), then the values up to the length specified are returned. 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 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.

device -- specified by user, fullword integer

Locator device number.

start -- specified by user, fullword integer

Starting member of the list of prompt/echo types (>=1)

number -- specified by user, fullword integer

Number of prompt/echo types requested (>=0)

length -- specified by user, fullword integer

Length of locator data record array, in bytes, provided by the application for the graPHIGS API to return data record (>=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:

23: SPECIFIED WORKSTATION TYPE DOES NOT EXIST
38: WORKSTATION HAS ONLY OUTPUT CAPABILITIES
140: DEVICE NUMBER < ONE OR DEVICE NOT AVAILABLE
509: DATA LENGTH VALUE < ZERO OR REQUIRED LENGTH
533: INQUIRY DATA EXCEEDS AREA. OUTPUT TRUNCATED
538: START VALUE < ONE
539: REQUESTED NUMBER < ZERO
543: START EXCEEDS DATA EXTENT. TOTAL NUMBER AVAILABLE RETURNED
548: SPECIFIED WORKSTATION TYPE CANNOT BE LOADED

dimen -- returned by the graPHIGS API, fullword integer

Type of locator device (1=2D, 2=3D )

pos -- returned by the graPHIGS API, 3 short floating-point numbers (WC)

Default initial locator position.

necho -- returned by the graPHIGS API, fullword integer

Total number of available prompt/echo types.

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

List of available prompt/echo types requested. The output array must be large enough to contain the requested data.

area -- returned by the graPHIGS API, 6 short floating-point numbers (DC)

Default echo area (Xmin, Xmax, Ymin, Ymax, Zmin, Zmax)

datalen -- returned by the graPHIGS API, fullword integer

Default locator data record length, in bytes.

data -- returned by the graPHIGS API, variable length data

Default locator data record for the default prompt/echo type (1=TYPE )

Error Codes

None

Related Subroutines

GPINLC: Initialize Locator
GPQRCT: Inquire Realized Connection Type

RCP code

201340163 (X'0C003503')