TCPIP_ARP_EntryQuery Function

C

TCPIP_ARP_RESULT TCPIP_ARP_EntryQuery(
    TCPIP_NET_HANDLE hNet, 
    size_t index, 
    TCPIP_ARP_ENTRY_QUERY* pArpQuery
);

Description

This function can be used for displaying the cache contents.

Preconditions

The ARP module should have been initialized. The index has to be a valid one. For example, TCPIP_ARP_CacheEntriesNoGet populates the supplied TCPIP_ARP_ENTRY_QUERY query entry.

Parameters

ParametersDescription
hNetInterface handle to use.
indexIndex to cache.
pArpQueryEntry type, IP address, hardware address.

Returns

  • On Success - ARP_RES_OK.

  • On Failure - ARP_RES_BAD_INDEX (if index is out of range) ARP_RES_NO_INTERFACE (if no such interface exists) .

Remarks

None.