FB_SocketUdpDropMulticastAddress

Available since product version: TwinCAT TCP/IP Connection Server 1.0.64 or higher

FB_SocketUdpDropMulticastAddress 1:

Removes the binding to a Multicast IP address which has previously been added via the function block FB_SocketUdpAddMulticastAddress.

VAR_INPUT

VAR_INPUT
    sSrvNetId       : T_AmsNetId := '';
    hSocket         : T_HSOCKET;
    sMulticastAddr  : STRING(15);
    bExecute        : BOOL;
    tTimeout        : TIME := T#5s;
END_VAR

sSrvNetId: String containing the network address of the TwinCAT TCP/IP Connection Server. For the local computer (default) an empty string may be specified.

hSocket: Connection handle of the listener sockets. This handle must first be requested via the function block FB_SocketUdpCreate.

sMulticastAddr: Multicast address for which the binding should be removed.

bExecute: The block is activated by a rising edge at this input.

tTimeout: Maximum time allowed for the execution of the function block.

VAR_OUTPUT

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

bBusy: When the function block is activated this output is set. It remains set until and acknowledgement is received.

bError: If an error should occur during the transfer of the command, then this output is set once the bBusy output was reset.

nErrId : If the bError output is set, this parameter returns the TwinCAT TCP/IP Connection Server error number.

Requirements

Development environment

Target system type

PLC libraries to be linked

TwinCAT version 2.8.0 or higher

PC or CX (x86)

TcpIp.lib

 

TwinCAT v2.10.0 Build >= 1301

CX (ARM)