Session.WaitForKeyboardUnlocked Method
- Julio Rios (Unlicensed)
Waits for a specified amount of time (the default is 60 seconds) for the keyboard to be unlocked; if the keyboard is not locked, or becomes unlocked during the wait period, Wait returns immediately.
The time to wait can be changed with the SetSessionOptions(String, Int32) method.
Namespace: Â JollyGiant.Emulation
Assembly: Â JGSComdotNet (in JGSComdotNet.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
| C# |
|---|
public StatusCode WaitForKeyboardUnlocked() |
| Visual Basic (Declaration) |
|---|
Public Function WaitForKeyboardUnlocked As StatusCode |
| Visual C++ |
|---|
public: virtual StatusCode WaitForKeyboardUnlocked() sealed |
| JavaScript |
|---|
function WaitForKeyboardUnlocked(); |
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. |
| WHLLPSBUSY | Wait method timed out while still in XCLOCK or XSYSTEM for 3270 terminals, or Input Inhibited for 5250 terminals. |
| WHLLINHIBITED | The keyboard is locked. |
| WHLLSYSERROR | The method failed due to a system error. |
Implements
ISession.WaitForKeyboardUnlocked()
Remarks
Wait can be used to provide other methods, such as , enough time to complete or be processed. You can also use WaitForKeyboardUnlocked to see if keyboard input is inhibited.
Be aware, however, that when the return code is WHLLOK, the keyboard is unlocked, but the original transaction or preceding method may not have finished processing on the host.
The length of time that this method will wait is affected by the session options TWAIT, LWAIT, and NWAIT.
See Also
Session Class
JollyGiant.Emulation Namespace
Session.SendKeys(String)
Send comments on this topic to Jolly Giant Software
Copyright 2009 by Jolly Giant Software, Inc.