Edit

NDIS_PD_CLEAR_RECEIVE_FILTER callback function (ndis.h)

  • Article

The PacketDirect (PD) platform calls a PD-capable miniport driver's NdisPDClearReceiveFilter function to clear this filter from the PD platform.

Note  You must declare the function by using the NDIS_PD_CLEAR_RECEIVE_FILTER type. For more information, see the following Examples section.

 

Syntax

NDIS_PD_CLEAR_RECEIVE_FILTER NdisPdClearReceiveFilter;

VOID() NdisPdClearReceiveFilter(
  [in] NDIS_PD_FILTER_HANDLE FilterHandle
)
{...}

Parameters

[in] FilterHandle

A handle to a PD platform filter.

Return value

This callback function does not return a value.

Remarks

After this function returns, it's guaranteed that no more newly arriving packet will match this filter. However, there may still be in-flight packets that have already matched this filter and they are on their way to being placed into the target receive queue.

Examples

To define a NdisPDClearReceiveFilter function, you must first provide a function declaration that identifies the type of function you're defining. Windows provides a set of function types for drivers. Declaring a function using the function types helps Code Analysis for Drivers, Static Driver Verifier (SDV), and other verification tools find errors, and it's a requirement for writing drivers for the Windows operating system.

For example, to define a NdisPDClearReceiveFilter function that is named "MyPDClearReceiveFilter", use the NDIS_PD_CLEAR_RECEIVE_FILTER type as shown in this code example:

NDIS_PD_CLEAR_RECEIVE_FILTER MyPDClearReceiveFilter;

Then, implement your function as follows:

_Use_decl_annotations_
VOID
 MyPDClearReceiveFilter(
    NDIS_PD_FILTER_HANDLE  FilterHandle
    )
  {...}

The NDIS_PD_CLEAR_RECEIVE_FILTER function type is defined in the Ntddndis.h header file. To more accurately identify errors when you run the code analysis tools, be sure to add the Use_decl_annotations annotation to your function definition. The Use_decl_annotations annotation ensures that the annotations that are applied to the NDIS_PD_CLEAR_RECEIVE_FILTER function type in the header file are used. For more information about the requirements for function declarations, see Declaring Functions by Using Function Role Types for NDIS Drivers.

For information about Use_decl_annotations, see Annotating Function Behavior.

Requirements

Requirement Value
Minimum supported client Windows 10
Minimum supported server Windows Server 2016
Target Platform Windows
Header ndis.h
IRQL PASSIVE_LEVEL