Jump to main content

##

# TCPIP_ARP_EntrySet Function

## C

    TCPIP_ARP_RESULT TCPIP_ARP_EntrySet(
        TCPIP_NET_HANDLE hNet,
        IPV4_ADDR* ipAdd,
        TCPIP_MAC_ADDR* hwAdd,
        bool perm
    );

## Description

This function will add an entry to the selected interface cache. The entry can be marked as as permanent (not subject to timeouts or updates from the network). If cache is full, an entry will be deleted to make room.

## Preconditions

The ARP module should have been initialized.

## Parameters

Parameters | Description
--- | ---
hNet | Interface to use.
IPAdd | The IP address.
hwAdd | The mapping MAC address for the supplied ipAdd.
perm | If true, the entry will be marked as permanent.

## Returns

- On Success - ARP_RES_OK/ARP_RES_ENTRY_EXIST.
- On Failure - An Error for example, cache is full with permanent entries that cannot be purged or the permanent quota exceeded).

## Remarks

None.