NDIS_RECEIVE_FILTER_INFO structure (ntddndis.h)

Article
02/22/2024

The NDIS_RECEIVE_FILTER_INFO structure contains information about a receive filter that is currently configured on a miniport driver.

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_INFO {
  NDIS_OBJECT_HEADER       Header;
  ULONG                    Flags;
  NDIS_RECEIVE_FILTER_TYPE FilterType;
  NDIS_RECEIVE_FILTER_ID   FilterId;
} NDIS_RECEIVE_FILTER_INFO, *PNDIS_RECEIVE_FILTER_INFO;

Members

Header

The NDIS_OBJECT_HEADER structure for the NDIS_RECEIVE_FILTER_INFO 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_INFO structure, the driver sets the Revision member to one of the following values:

NDIS_RECEIVE_FILTER_INFO_REVISION_1

Original version for NDIS 6.20.

The driver sets the Size member to NDIS_SIZEOF_RECEIVE_FILTER_INFO_REVISION_1.

Flags

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

FilterType

The type of the receive filter.

FilterId

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

Remarks

The NDIS_RECEIVE_FILTER_INFO structure is used with the NDIS_RECEIVE_FILTER_INFO_ARRAY structure for the OID request of OID_RECEIVE_FILTER_ENUM_FILTERS. This OID request enumerates receive filters that have been configured on the miniport driver. This includes packet coalescing receive filters or the receive filters configured on a receive queue that is used in the VMQ or SR-IOV interface.

Requirements

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