NDK_FN_GET_PEER_ADDRESS callback function (ndkpi.h)

Article
10/21/2021

The NdkGetPeerAddress (NDK_FN_GET_PEER_ADDRESS) function returns the remote address for an NDK connection.

Syntax

NDK_FN_GET_PEER_ADDRESS NdkFnGetPeerAddress;

NTSTATUS NdkFnGetPeerAddress(
  [in] NDK_CONNECTOR *pNdkConnector,
       PSOCKADDR pAddress,
       ULONG *pAddressLength
)
{...}

Parameters

[in] pNdkConnector

A pointer to an NDK connector object (NDK_CONNECTOR).

pAddress

A remote address is returned in this buffer.

pAddressLength

The size, in bytes, of the address buffer for input, and the size, in bytes, of the actual address written into the buffer for output.

Return value

The NdkGetPeerAddress function returns one of the following NTSTATUS codes.

Return code	Description
STATUS_SUCCESS	A remote address was written to the buffer in the pAddress parameter.
STATUS_BUFFER_TOO_SMALL	The buffer size specified in the pAddressLength parameter input is too small. pAddressLength output value is updated with the required buffer size.
Other status codes	An error occurred.

Remarks

NdkGetPeerAddress returns the remote address for a connection.

Requirements

Requirement	Value
Minimum supported client	None supported,Supported in NDIS 6.30 and later.
Minimum supported server	Windows Server 2012
Target Platform	Windows
Header	ndkpi.h (include Ndkpi.h)
IRQL	<=DISPATCH_LEVEL