FB_SocketClose

The function block FB_SocketClose can be used to close an open TCP/IP or UDP socket.

TCP/IP: The listener socket is opened with the function block FB_SocketListen, a local client socket with FB_SocketConnect and a remote client socket with FB_SocketAccept.

UDP: The UDP socket is opened with the function block FB_SocketUdpCreate.

Inputs

VAR_INPUT
    sSrvNetId   : T_AmsNetId := '';
    hSocket     : T_HSOCKET;
    bExecute    : BOOL;
    tTimeout    : TIME := T#5s;
END_VAR

Name	Type	Description
sSrvNetId	T_AmsNetId	String containing the network address of the TwinCAT TCP/IP Connection Server. For the local computer (default) an empty string may be specified.
hSocket	T_HSOCKET	TCP/IP: Connection handle of the listener, remote or local client socket to be closed. UDP: Connection handle of the UDP socket.
bExecute	BOOL	The function block is enabled by a positive edge at this input.
tTimeout	TIME	Maximum time allowed for the execution of the function block.

VAR_OUTPUT
    bBusy     : BOOL;
    bError    : BOOL;
    nErrId    : UDINT;
END_VAR

Name	Type	Description
bBusy	BOOL	This output is active if the function block is activated. It remains active until acknowledgement.
bError	BOOL	If an error should occur during the transfer of the command, then this output is set once the bBusy output was reset.
nErrId	UDINT	If an bError output is set, this parameter returns the TwinCAT TCP/IP Connection Server error number.

Development environment	Target system type	PLC libraries to include (category group)
TwinCAT v3.1.0	PC, or CX (x86, X64, ARM)	Tc2_TcpIp (communication)