wodSSHServer ActiveX Control - ServiceStart Method
      
 

Description

Called when user starts requested service.


Return Type

None  


Syntax

object.ServiceStart Owner, User, ServiceIndex, ServiceType, ServiceName



The ServiceStart Method syntax has these parts:

Part Description
object An expression evaluating to an object of type wodSSHD-Notifications.
Owner A wodSSHDCom object. Instance of wodSSHServer that called this notification method.
User A SSHUser object. Reference to user who started a service.
ServiceIndex An Integer value. Index of the service (starts from 0).
ServiceType A SSHServiceTypes enumeration, as described in settings. Type of the service.
ServiceName A String value. Name of the service, as given by the client.

Settings

The settings for ServiceType are:

Constant Value Description
 stNone 0 No service.
 stShell 1 Command prompt.
 stExecute 2 Execute program.
 stSubsystem 3 External subsystem.
 stPortForwarding 4 Port forwarding.
 stSCP 5 Secure file copy.

Remarks

This method is called only if you implemented IwodSSHNotify interface in your application, and wodSSHD.Notification property has received reference to instance of your implementation.

This notification method is called just after actual service is started. Before this notification method you should have received ServiceRequest notification method for the same service, where you did have option to Deny it.

This is good place to start some conversation with the client in case ServiceType is stNone. Also, if user requested stShell, you can send some welcome message from here which will be visible by the user before any other content. You should not send anything if service is stSubsystem or stPortForwarding, because you will interfere with above layer protocols.