NDIS_RECEIVE_FILTER_CLEAR_PARAMETERS structure (ntddndis.h)

Article
07/22/2022

The NDIS_RECEIVE_FILTER_CLEAR_PARAMETERS structure specifies the parameters to clear a receive filter on a network adapter.

NDIS receive filters are used in the following NDIS interfaces:

NDIS Packet Coalescing. For more information about how to use receive filters in this interface, see Managing Packet Coalescing Receive Filters.
Single Root I/O Virtualization (SR-IOV). For more information about how to use receive filters in this interface, see Setting a Receive Filter on a Virtual Port.
Virtual Machine Queue (VMQ). For more information about how to use receive filters in this interface, see Setting and Clearing VMQ Filters.

Syntax

typedef struct _NDIS_RECEIVE_FILTER_CLEAR_PARAMETERS {
  NDIS_OBJECT_HEADER     Header;
  ULONG                  Flags;
  NDIS_RECEIVE_QUEUE_ID  QueueId;
  NDIS_RECEIVE_FILTER_ID FilterId;
} NDIS_RECEIVE_FILTER_CLEAR_PARAMETERS, *PNDIS_RECEIVE_FILTER_CLEAR_PARAMETERS;

Members

Header

The NDIS_OBJECT_HEADER structure for the NDIS_RECEIVE_FILTER_CLEAR_PARAMETERS structure. The driver sets the Type member of the structure that Header specifies to NDIS_OBJECT_TYPE_DEFAULT.

To indicate the version of the NDIS_RECEIVE_FILTER_CLEAR_PARAMETERS structure, the driver sets the Revision member to one of the following values:

NDIS_RECEIVE_FILTER_CLEAR_PARAMETERS_REVISION_1

Original version for NDIS 6.20.

The driver sets the Size member to NDIS_SIZEOF_RECEIVE_FILTER_CLEAR_PARAMETERS_REVISION_1.

Flags

A bitwise OR of flags. This member is reserved for NDIS.

QueueId

A receive queue identifier. This identifier is an integer between zero and the number of queues that the network adapter supports. A value of NDIS_DEFAULT_RECEIVE_QUEUE_ID specifies the default receive queue.

Note Miniport drivers that support NDIS packet coalescing or the SR-IOV interface must set the QueueId member to NDIS_DEFAULT_RECEIVE_QUEUE_ID.

FilterId

A receive filter identifier. The filter identifier is an integer from one to the number of receive filters that the network adapter supports. A value of zero is not valid.

Remarks

The NDIS_RECEIVE_FILTER_CLEAR_PARAMETERS structure is used with OID requests of
OID_RECEIVE_FILTER_CLEAR_FILTER to specify a filter to clear on a VMQ or SR-IOV VPort receive queue. The filter was previously set on the queue with the OID_RECEIVE_FILTER_SET_FILTER OID.

Requirements

Requirement	Value
Minimum supported client	Supported in NDIS 6.20 and later.
Header	ntddndis.h (include Ndis.h)