Checks the connected QWS3270 instance for the keyboard status.

Namespace: JollyGiant.Emulation
Assembly: JGSComdotNet (in JGSComdotNet.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C#
StatusCode TestForKeyboardUnlocked()

Visual Basic (Declaration)
Function TestForKeyboardUnlocked As StatusCode

Visual C++
StatusCode TestForKeyboardUnlocked()

JavaScript
function TestForKeyboardUnlocked();

Return Value

The StatusCode indicating the result of the operation.

This can be one of the following values:

Status code	Description
WHLLOK	The keyboard is unlocked and ready for input.
WHLLNOTCONNECTED	Your application is not connected to a valid host session.
WHLLINHIBITED	The keyboard is locked.
WHLLSYSERROR	The method failed due to a system error.

Remarks

TestForKeyboardUnlocked can only be used to check the current keyboard status. Be aware that by the time this method returns, the keyboard status may already have changed due to user input or host data.

This method will not wait for the keyboard status to change, but instead return immediately.

See Also

ISession Interface
JollyGiant.Emulation Namespace

Send comments on this topic to Jolly Giant Software

Copyright 2009 by Jolly Giant Software, Inc.