Login Method  
 

Establish an interactive terminal session for the specified user.

Syntax

object.Login( [RemoteHost], [RemotePort], [UserName], [Timeout], [Options] )

Parameters

RemoteHost
A optional string argument which specifies the name of the server to connect to. The string may either be an IP address or a fully qualified domain name. If the argument is omitted, the value of the HostAddress or HostName property will be used.
RemotePort
An optional integer argument which specifies the port number to connect to. If this argument is omitted, the value of the RemotePort property will be used. A remote port of zero specifies that port 513 should be used, which is the standard port number for the rlogin service.
UserName
An optional string argument which specifies the username which should be used to authenticate the client session. If this argument is omitted, the value of the UserName property will be used.
Timeout
An optional integer argument which specifies the number of seconds that the client will wait for a response from the server. If this argument is omitted, the value of the Timeout property will be used. This value is only used for synchronous connections where the Blocking property is set to True.
Options
An optional integer argument which specifies one or more connection options. This argument is reserved for future use and should be omitted.

Return Value

A value of zero is returned if the operation was successful, otherwise a non-zero error code is returned which indicates the cause of the failure.

Remarks

The Login method logs the specified user in on the server. Note that no password is provided to the server. This is because the remote login service uses user equivalence. If the client system is recognized by the server as being equivalent, the login will proceed directly. If the client system is not recognized, the server will prompt the user for a password. For more information about user equivalence and the remote login service, refer to your server's operating system documentation.

Output from the command may be read using the Read method. Input can be supplied to the program using the Write method. To search for a specific sequence of bytes in the output returned by the server, use the Search method.

See Also

Disconnect Method, Execute Method, Read Method, Search Method