NDK_FN_CREATE_LISTENER callback function

The NdkCreateListener (NDK_FN_CREATE_LISTENER) function creates an NDK listener object.

Syntax


NDK_FN_CREATE_LISTENER NdkCreateListener;

NTSTATUS NdkCreateListener(
  _In_     NDK_ADAPTER                   *pNdkAdapter,
  _In_     NDK_FN_CONNECT_EVENT_CALLBACK ConnectEvent,
  _In_opt_ PVOID                         ConnectEventContext,
  _In_     NDK_FN_CREATE_COMPLETION      CreateCompletion,
  _In_opt_ PVOID                         RequestContext,
           _Outptr_ NDK_LISTENER         **ppNdkListener
)
{ ... }

Parameters

pNdkAdapter [in]

A pointer to an NDK adapter object (NDK_ADAPTER).

ConnectEvent [in]

A pointer to the NdkConnectEventCallback function (NDK_FN_CONNECT_EVENT_CALLBACK) that the provider uses to notify the consumer for each incoming connection request.

ConnectEventContext [in, optional]

A context value that the NDK provider passes back to the NdkConnectEventCallback function that is specified in the ConnectEvent parameter.

CreateCompletion [in]

A pointer to an NdkCreateCompletion (NDK_FN_CREATE_COMPLETION) function that completes the creation of an NDK object.

RequestContext [in, optional]

A context value that the NDK provider passes back to the NdkCreateCompletion function that is specified in the CreateCompletion parameter.

ppNdkListener

A pointer to the created NDK listener object (NDK_LISTENER) is returned in this location if request succeeds without returning STATUS_PENDING. If NdkCreateListener returns STATUS_PENDING this parameter is ignored and the created object is returned with the callback that is specified in the CreateCompletion parameter.

Return value

The NdkCreateListener function returns one of the following NTSTATUS codes.

Return codeDescription
STATUS_SUCCESS

The listener object was created successfully and returned with the *ppNdkListener parameter.

STATUS_PENDING

The operation is pending and will be completed later. The provider will call the function specified in the CreateCompletion parameter(NDK_FN_CREATE_COMPLETION) to complete the pending operation.

STATUS_INSUFFICIENT_RESOURCES

The request failed due to insufficient resources.

Important  The request can fail inline as well as asynchronously with this status code.
 
Other status codes

An error occurred.

 

Remarks

The NdkCreateListener function creates an NDK listener object. If the function returns STATUS_SUCCESS, the created object is returned in the ppNdkListener parameter. If NdkCreateListener returns STATUS_PENDING, the created object is returned by the NdkCreateCompletion (NDK_FN_CREATE_COMPLETION) function that is specified in the CreateCompletion parameter.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012

Target platform

Version

Supported in NDIS 6.30 and later.

Header

Ndkpi.h (include Ndkpi.h)

IRQL

<=DISPATCH_LEVEL

See also

NDK_ADAPTER
NDK_ADAPTER_DISPATCH
NDK_LISTENER
NDK_FN_CONNECT_EVENT_CALLBACK
NDK_FN_CREATE_COMPLETION
NDKPI Object Lifetime Requirements

 

 

Send comments about this topic to Microsoft

Show: