|
|
Establish a connection with a remote server.
Syntax
object.Connect( [RemoteHost],
[RemotePort], [UserName], [Password],
[Timeout], [Options] )
Remarks
This method establishes a network connection with a remote
server. All arguments are optional. If a given argument is missing,
then a corresponding property or properties must be set before
attempting the connection, as follows:
- RemoteHost
- A string which specifies the host name or IP address of the
remote host. If this argument is not specified, it defaults to the
value of the HostAddress property if it is defined.
Otherwise, it defaults to the value of the HostName
property.
- RemotePort
- A number which specifies the port to connect to on the remote
host. If this argument is not specified, it defaults to the value
of the RemotePort property. A value of zero indicates that
the default port number for this service should be used to
establish the connection. If the secure port number is specified,
an implicit SSL/TLS connection will be established by default.
- UserName
- A string which specifies the name of the user used to
authenticate access to the server. If this argument is not
specified, it defaults to the value of the UserName
property.
- Password
- A string which specifies the password used to authenticate the
user. If this argument is not specified, it defaults to the value
of the Password property.
- Timeout
- The number of seconds that the client will wait for a response
before failing the operation. A value of zero indicates that the
client should wait an indefinite period of time. If this argument
is not specified, the value of the Timeout property will be
used as the default.
- Options
- A numeric value which specifies one or more options. If this
argument is omitted or a value of zero is specified, a default
connection will be established. This argument is constructed by
using a bitwise operator with any of the following values:
| Value |
Constant |
Description |
| 4096 |
imapOptionSecure |
This option specifies that the
client should attempt to establish a secure connection with the
server. Note that the server must support secure connections using
either the SSL or TLS protocol. This option is only available in
the Secure Editions of SocketTools. |
Return Value
A value of zero is returned if the connection was successful.
Otherwise, a non-zero error code is returned which indicates the
cause of the failure.
See Also
HostAddress Property,
HostName Property, RemotePort Property, RemoteService Property,
Disconnect Method, OnConnect Event
|
|