RtNalDisableReceivePolling

RtNalDisableReceivePolling stops the NAL from polling the receive queue started RtNalEnableReceivePolling.

Syntax

BOOL RtNalDisableReceivePolling(
	RTNAL_QUEUE_HANDLE queueHandle,
);

Parameters

queueHandle

The receive handle queue returned by RtNalAcquireQueue.

Return Value

Returns TRUE if the call 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_PARAMETER queueHandle is a NULL pointer.
ERROR_NOT_FOUND A receive polling timer is disabled.
ERROR_NOT_READY RtNalInit has not completed successfully.

Remarks

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

The polling of the receive queue for Ethernet frames done by the NAL is stopped. All Ethernet frames received in this queue are discarded after polling is disabled.

Requirements

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

See Also: