graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQBKS - Inquire Break Action State

GPQBKS (wsid, errind, trigger)

Note:

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

Purpose

Use GPQBKS to inquire the current break action trigger on the specified workstation.

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

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

trigger -- returned by the graPHIGS API, 2 fullword integers

Trigger to be used on the specified workstation for the break action. The trigger consists of a trigger type followed by a trigger qualifier. Positive integers as trigger types are button device numbers. The trigger qualifier for a button device is the choice alternative.

Error Codes

None

Related Subroutines

GPBKAC: Set Break Action
GPQBK: Inquire Break Capabilities
GPQDBK: Inquire Default Break Action

RCP code

201336843 (X'0C00280B')