ResolveNeighbor function (iphlpapi.h)

[ResolveNeighbor is no longer available for use as of Windows Vista. Instead, use ResolveIpNetEntry2.]

The ResolveNeighbor function resolves the physical address for a neighbor IP address entry on the local computer.

Syntax

IPHLPAPI_DLL_LINKAGE ULONG ResolveNeighbor(
  [in]      SOCKADDR *NetworkAddress,
  [out]     PVOID    PhysicalAddress,
  [in, out] PULONG   PhysicalAddressLength
);

Parameters

[in] NetworkAddress

A pointer to a SOCKADDR structure that contains the neighbor IP address entry and address family.

[out] PhysicalAddress

A pointer to a byte array buffer that will receive the physical address that corresponds to the IP address specified by the NetworkAddress parameter if the function is successful. The length of the byte array is passed in the PhysicalAddressLength parameter.

[in, out] PhysicalAddressLength

On input, this parameter specifies the maximum length, in bytes, of the buffer passed in the PhysicalAddress parameter to receive the physical address. If the function is successful, this parameter will receive the length of the physical address returned in the buffer pointed to by the PhysicalAddress parameter. If ERROR_BUFFER_OVERFLOW is returned, this parameter contains the number of bytes required to hold the physical address.

Return value

The ResolveNeighbor function always fails and returns the following error code.

Return code Description
ERROR_NOT_SUPPORTED
The request is not supported.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header iphlpapi.h
Library Iphlpapi.lib
DLL Iphlpapi.dll

See also

ResolveIpNetEntry2

SOCKADDR