Skip to main content

​
IpRemoveAdapterAddress

CAPL Functions » TCP/IP API » IpRemoveAdapterAddress Valid for: CANoe DE • CANoe4SW DE

​
Function Syntax

  • long IpRemoveAdapterAddress (dword ifIndex, dword ipv4address, dword ipv4mask); // form 1
  • long IpRemoveAdapterAddress (dword ifIndex, byte ipv6Address[], dword prefix); // form 2
  • long IpRemoveAdapterAddress (dword ifIndex, IP_Address address, dword prefix); // form 3

​
Description

The function removes an address from the network interface with the given index. Note: The function is dependent on the selected stack. This functionality cannot be used in connection with the operating system TCP/IP stack.

​
Parameters

  • ifIndex: The 1-based network interface index. All adapter addresses including the local loopback address are taken into account in the stack of the operating system. The order depends on how the operating system lists the adapters. All assigned addresses including the VLAN addresses are taken into account in the CANoe DE product stack.
  • ipv4address: The numerical IPv4 address to remove from the interface.
  • ipv6Address: The IPv6 address to remove from the interface in a 16 byte array.
  • ipv4mask: The IPv4 network mask in network byte order.
  • prefix: The IPv6 prefix for the given IPv6 address.
  • address: IP Address to add to the interface.

​
Return Values

  • 0: The function completed successfully.
  • 1: The function is not supported on the selected TCP/IP stack.
  • WSA_INVALID_PARAMETER (87): The specified network interface index was invalid.
  • SOCKET_ERROR (-1): The function failed. Call IpGetLastSocketError to get a more specific error code.

​
Example

variables
{
  UdpSocket gSocket;
}

on start
{
  ipAddAdapterAddress( 1, IP_Address( 192.168.0.116 ), 24 );
  gSocket = UdpSocket::Open( IP_Endpoint(192.168.0.116:40016) );
  gSocket.SendTo( IP_Endpoint(192.168.0.255:40255), "Hello", 5 );
}

on preStop
{
  ipRemoveAdapterAddress( 1, IP_Address( 192.168.0.116 ), 24 );
}