ConnectToRemoteServer (Method)

Overview

Type:

Interface

Available as of:

V1.0.2.0

Inherits from:

-

Description

This method is used to establish a connection to the specified remote server through the connected proxy server. The execution is considered as successfully completed when the referenced instance of the TCP client is connected the remote server.

The return value of type BOOL is used to indicate that the connection to the remote server was established successfully.

Interface

Input/Output

Data type

Description

iq_fbTcpClient

TCPUDP.FB_TcpClient2

Specifies the instance of the FB_TcpClient2 for which the connection is established.

Input/Output CONSTANT(1)

Data type

Description

iq_sHostname

STRING[255]

Specifies the fully qualified host name (FQHN) by which the remote server can be reached.

(1) VAR IN_OUT CONSTANT supports the assignment of a string constant. For further information refer to Variable Types.

Input

Data type

Description

i_uiServerPort

UINT

Specifies the TCP port of the remote server to which the connection is established.

i_xUpgradeToTls

BOOL

Specifies whether the socket is upgraded to TLS after the connection is established. This option is used for connections which are established on sockets of type StartTls.

Output

Data type

Description

q_xBusy

BOOL

Set this output to TRUE when the establishing of the connection is in progress and a further call of the method is required.

q_xDone

BOOL

Set this output to TRUE when the connection has been established successfully.

q_xError

BOOL

Set this output to TRUE when an error has been detected. Additional information about the error is provided via the properties Result and ResultMsg.