RtNalClearReceiveFilterEntryEthertype

RtNalClearReceiveFilterEntryEthertype clears a receive Ethernet type filter with the specified index in the NIC driver.

Syntax

BOOL RtNalClearReceiveFilterEntryEthertype(
	RTNAL_QUEUE_HANDLE queueHandle,
	ULONG filterIndex
);

Parameters

queueHandle

The receive queue handle returned by RtNalAcquireQueue.

filterIndex

Indicates which entry in the filter to clear. The range of filter indexes is device-specific. For the RtNalIGB and RtNalI10GB drivers, this value is a number between 0-7.

Return Value

Returns TRUE if the function succeeds. Otherwise it returns FALSE. Call GetLastError to obtain an error code. The possible error codes are listed below:

Error Code	Meaning
ERROR_INVALID_HANDLE	Invalid queue handle.
ERROR_INVALID_INDEX	Invalid filter entry index.
ERROR_INVALID_PARAMETER	queueHandle is a NULL pointer.
ERROR_NOT_OWNER	This filter entry is used by another receive queue.
ERROR_NOT_READY	RtNalInit has not completed successfully.
ERROR_NOT_SUPPORTED	The queue is not a receive queue.
ERROR_DEVICE_FEATURE_NOT_SUPPORTED	The driver does not support receive Ethernet type filtering.

Remarks

For a list of supported functions for specific drivers, see Matrix of Supported Real-Time NAL Functions by NIC Driver.

The device driver must support RTNAL_IOCTL_CLEAR_RX_ETHERTYPE_FILTER IOCTL for this function to succeed.

All receive Ethernet type filters are cleared when the queue is released.

The RtNalIPCH and RtNalE1000 drivers do not support receive filtering.

Requirements

Minimum Supported Version	RTX64 4.0
Header	rtnapi.h, RtNalApi.h
Library	RtNal.lib