Session.TestForKeyboardUnlocked Method
- Julio Rios (Unlicensed)
Owned by Julio Rios (Unlicensed)
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# |
|---|
public StatusCode TestForKeyboardUnlocked() |
| Visual Basic (Declaration) |
|---|
Public Function TestForKeyboardUnlocked As StatusCode |
| Visual C++ |
|---|
public: virtual StatusCode TestForKeyboardUnlocked() sealed |
| 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. |
Implements
ISession.TestForKeyboardUnlocked()
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
Session Class
JollyGiant.Emulation Namespace
Send comments on this topic to Jolly Giant Software
Copyright 2009 by Jolly Giant Software, Inc.