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


Namespace: ScreenUPG
Assembly: ScreenUPG (in ScreenUPG.dll)

Syntax

Visual Basic (Declaration)
Public Sub waitHostQuiet( _ 
   ByVal inSettleTime As Integer,  _ 
   ByVal inWaitOptions As Integer _ 
)
C#
public void waitHostQuiet(
   int inSettleTime,
   int inWaitOptions
)
C++
public:
 void waitHostQuiet(
   int inSettleTime,
   int inWaitOptions
) sealed 
J#
public void waitHostQuiet(
   int inSettleTime,
   int inWaitOptions
)
JScript
public  function waitHostQuiet(
   inSettleTime : int,
   inWaitOptions : int
)

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

Exception TypeCondition
T: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

[C#]

 Copy Code
            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());
            

See Also