RtNalGetReceivePacketCount

RtNalGetReceivePacketCount retrieves the number of packets in a NIC queue since the last call.

Syntax

BOOL RtNalGetReceivePacketCount(
	RTNAL_QUEUE_HANDLE queueHandle,
	PLONG pCount
);

Parameters

queueHandle

Network queue handle returned by RtNalAcquireQueue.

pCount

Pointer to a variable that will be filled with the packet count. This pointer cannot be NULL.

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_PARAMETER queueHandle or pCount is a NULL pointer.
ERROR_INVALID_HANDLE queueHandle is invalid. This might be occur if the queue was released in another thread or on process exit, as if by RtssKill.
ERROR_NOT_READY RtNalInit has not completed successfully.
ERROR_NOT_SUPPORTED This function is not supported for this queue type or for this device.

Remarks

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

RtNalGetReceivePacketCount is not supported by the RtTCPIPVirtualNIC device.

Requirements

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

See Also: