wodSSHTunnel ActiveX Control - UserConnected Method
 UserConnected Method
      
 

Description

Called when a user connects to the listening channel.


Return Type

None  


Syntax

object.UserConnected Owner, Chan, User, ErrorCode, ErrorText



The UserConnected Method syntax has these parts:

Part Description
object An expression evaluating to an object of type wodTunnelNotify.
Owner Required. A wodTunnelCom object. Reference to the wodTunnelCom instance that called this notification method.
Chan Required. A Channel object. Reference to the channel where the user connected.
User Required. An User object. Reference to the user that connected.
ErrorCode Required. An Integer value. Specifies the error that occurred, if any.
ErrorText Required. A String value. Holds a text description of the error.

Remarks

This method is called only if you have implemented the IwodSSHTunnelNotify interface in your application and the wodTunnel1.Notification property has received a reference to an instance of your implementation.

The UserConnected notification method is called after you have allowed the User to connect and use the channel that they have chosen. From this point, they will be communicating with the destination service through the secure channel.

If the connection for the user fails (for whatever reason), the ErrorCode argument will hold one of the following nonzero values:

Code Description
 
0 No Error
1 Administratively prohibited
2 Connect failed
3 Unknown channel type
4 Resource shortage
5 Unknown error, or not specified

If the server provides a text description, it will be provided through the ErrorText argument.