ScreenUPG
waitHostQuiet Method
Example 



ScreenUPG Assembly > ScreenUPG Namespace > ScreenUPG Class : waitHostQuiet Method
The amount of time (in milliseconds), that the session needs to be idle before the wait condition is satisfied. The optimum settle time varies depending on the host application and network response time. For most host applications, a settle time of one to three seconds is sufficient.
The number of milliseconds to wait for the wait condition to be satisfied before timing out.
Waits for the host session to be idle for a specified period of time (in milliseconds). A session is considered to be "quiet" when there has been no activity in the host session for the specified amount of time. This is a synchronous call and does not return until the wait condition is satisfied. Otherwise, it times out after wtTime (specified in milliseconds).
Syntax
'Declaration
 

Public Sub waitHostQuiet( _ 
   ByVal inSettleTime As Integer, _ 
   ByVal inWaitOptions As Integer _ 
) 
'Usage
 

Dim instance As ScreenUPG 
Dim inSettleTime As Integer 
Dim inWaitOptions As Integer 
  
instance.waitHostQuiet(inSettleTime, inWaitOptions)
public void waitHostQuiet( 
   int inSettleTime,
   int inWaitOptions 
)
public: 
void waitHostQuiet( 
   int inSettleTime,
   int inWaitOptions 
)

Parameters

inSettleTime
The amount of time (in milliseconds), that the session needs to be idle before the wait condition is satisfied. The optimum settle time varies depending on the host application and network response time. For most host applications, a settle time of one to three seconds is sufficient.
inWaitOptions
The number of milliseconds to wait for the wait condition to be satisfied before timing out.
Exceptions
ExceptionDescription
TimedOutException Thrown if waitHostQuiet times out.
Remarks
Note: Completion of this call does not indicate that data has been received from the host and/or that the presentation space has been updated. The user should check getKeyboardLocked. This is a quick indication of whether or not data has been received from the host.
Example
do
{
	try
	{
		int inSettleTime = 1000;
		int wtTime = 3000;
            
		// Wait for an idle timeout of 1 second with a total wait time of 3 seconds.
		screen.waitHostQuiet(inSettleTime, wtTime);
	}
	catch (TimedOutException toe)
	{
		// Host connection was not idle for 1 second during 3 second wait.
		Console.Write("TimedOutException toe\n");
	}
} while (screen.getKeyboardLocked());
Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

ScreenUPG Class
ScreenUPG Members
getKeyboardLocked Method
waitForCursor Method
waitForString Method