TCPIP_ARP_EntryRemoveNet Function

C

TCPIP_ARP_RESULT TCPIP_ARP_EntryRemoveNet(
    TCPIP_NET_HANDLE hNet, 
    IPV4_ADDR* ipAdd, 
    IPV4_ADDR* mask, 
    TCPIP_ARP_ENTRY_TYPE type
);

Description

This function removes all existent mappings belonging to a network interface. The performed operation: if(entry->type == type and entry->ipAdd & mask == ipAdd & mask) then remove entry.

Preconditions

The ARP module should have been initialized.

Parameters

ParametersDescription
hNetInterface to use.
IPAddThe IP address.
maskIP address of mask.
typevalid types of entries to remove: - ARP_ENTRY_TYPE_PERMANENT - ARP_ENTRY_TYPE_COMPLETE - ARP_ENTRY_TYPE_INCOMPLETE - ARP_ENTRY_TYPE_ANY

Returns

TCPIP_ARP_RESULT

  • On Success - ARP_RES_OK.

  • On Failure - ARP_RES_BAD_TYPE (if no such type exists) ARP_RES_NO_INTERFACE (if no such interface exists).

Remarks

None.