graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQST - Inquire String Device State

GPQST ( wsid, device, type, slen, length, errind, mode, echosw, strlen, string, echo, area, buflen, editpos, datalen, data)

Note:

This subroutine is a Workstation State List (WSL) inquiry. For an overview, see "WSL Inquiries"

Purpose

Use GPQST to inquire the current state of a string device attached to the specified workstation.

The graPHIGS API returns the current values of the specified device.

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 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 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

wsid -- specified by user, fullword integer

Workstation identifier.

device -- specified by user, fullword integer

String device number (>=1)

type -- specified by user, fullword integer

Type of returned values ( 1=SET )

slen -- specified by user, fullword integer

Length of the current initial string array, in bytes, provided by the application for the graPHIGS API to return corresponding data.

length -- specified by user, fullword integer

Length of requested string data record array, in bytes, provided by the application for the graPHIGS API to return corresponding data.

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
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
534: TYPE VALUE IS INVALID

mode -- returned by the graPHIGS API, fullword integer

Current operating mode (1=REQUEST, 2=SAMPLE, 3=EVENT, 4=APPLICATION_DEFINED ) The graPHIGS API only returns a mode of 4=APPLICATION_DEFINED if the application set the device mode using the Set Input Device State ( GPIDMO) subroutine and the mode does not emulate Request, Sample, or Event mode.

echosw -- returned by the graPHIGS API, fullword integer

Current echo switch ( 1=NOECHO, 2=ECHO )

strlen -- returned by the graPHIGS API, fullword integer

Current initial string length.

string -- returned by the graPHIGS API, variable length character string

Current initial string.

echo -- returned by the graPHIGS API, fullword integer

Current prompt/echo type.

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

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

buflen -- returned by the graPHIGS API, fullword integer

Current string input buffer size.

editpos -- returned by the graPHIGS API, fullword integer

Current cursor editing position.

datalen -- returned by the graPHIGS API, fullword integer

Current string data record length.

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

Current string data record.

Error Codes

None

Related Subroutines

GPIDMO: Set Input Device Mode
GPINST: Initialize String
GPQDST: Inquire Default String Device Data

RCP code

201338885 ( X'0C003005')