Jump to main content

##

# TCPIP_ARP_CacheThresholdSet Function

## C

    TCPIP_ARP_RESULT TCPIP_ARP_CacheThresholdSet(
        TCPIP_NET_HANDLE hNet,
        int purgeThres,
        int purgeEntries
    );

## Description

This function sets the current value of the cache threshold for the selected interface. During the ARP operation, once the number of entries in the cache is greater than the purge threshold a number of purgeEntries (usually one) will be discarded.

## Preconditions

The ARP module should have been initialized.

## Parameters

Parameters | Description
--- | ---
hNet | Interface handle to use.
purgeThres | Threshold to start cache purging.
purgeEntries | Number of entries to purge.

## Returns

- On Success - ARP_RES_OK.
- On Failure - ARP_RES_NO_INTERFACE (if no such interface exists).

## Remarks

None.