Opens a host session, waiting a specified time for the connection to be established before returning.


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

Syntax

Visual Basic (Declaration)
Public Function OpenEx( _ 
   ByVal timeout As Integer _ 
) As Boolean
C#
public bool OpenEx(
   int timeout
)
C++
public:
 bool OpenEx(
   int timeout
) sealed 
J#
public bool OpenEx(
   int timeout
)
JScript
public  function OpenEx(
   timeout : int
) : bool

Parameters

timeout
The number of seconds to wait for open to complete.

Return Value

true or false. If the session is opened successfully, the return value is true; otherwise it is false.

Remarks

Note: If the timeout is zero, OpenEx returns immediately, which may be before the host connection has been established. The developer should check for a true value returned by isConnected before calling additional API methods.

Example

[C#]

 Copy Code
            // Wait 10 seconds before timing out the open
            boolean isOpen = screen.OpenEx(10);
            
[VB]
 Copy Code
            Dim isOpen As Boolean
            
            'Wait 10 seconds before timing out the open
            open = screen.OpenEx(10)
            

See Also