NDK_FN_GET_SHARED_ENDPOINT_LOCAL_ADDRESS routine

The NdkGetSharedEndpointLocalAddress (NDK_FN_GET_SHARED_ENDPOINT_LOCAL_ADDRESS) function returns the local address for an NDK shared endpoint.

Syntax


NDK_FN_GET_SHARED_ENDPOINT_LOCAL_ADDRESS NdkGetSharedEndpointLocalAddress;

NTSTATUS NdkGetSharedEndpointLocalAddress(
  _In_  NDK_SHARED_ENDPOINT *pNdkSharedEndpoint,
  _Out_writes_bytes_to_opt_(*pAddressLength, *pAddressLength) PSOCKADDR pAddress,
  _Inout_ ULONG *pAddressLength
)
{ ... }

Parameters

pNdkSharedEndpoint [in]

A pointer to an NDK shared endpoint object (NDK_SHARED_ENDPOINT).

pAddress

A local 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 NdkGetSharedEndpointLocalAddress function returns one of the following NTSTATUS codes.

Return codeDescription
STATUS_SUCCESS

A local 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

NdkGetSharedEndpointLocalAddress returns the local address for a shared endpoint. NdkGetSharedEndpointLocalAddress retrieves port information for an AF_INET or AF_INET6 shared endpoint. That is, if the NDK consumer specifies zero as the ND port number in a shared endpoint creation request, the NDK provider picks a port. An NDK consumer can determine the port that the provider picked with NdkGetSharedEndpointLocalAddress.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012

Version

Supported in NDIS 6.30 and later.

Header

Ndkpi.h (include Ndkpi.h)

IRQL

<=DISPATCH_LEVEL

See also

NDK_SHARED_ENDPOINT

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft. All rights reserved.