RtndStopRxQueue
RtndStopRxQueue stops the specified Receive Queue.
Syntax
BOOL RtndStopRxQueue(
[in] ULONG_PTR RtndInterfaceId,
[in] ULONG RxQueueIndex,
[in, ignored] ULONG Flags
);
Parameters
[in] RtndInterfaceId
The number or pointer used to identify the interface. This value is returned by RtndManageInterface.
[in] RxQueueIndex
The index of the Receive Queue.
[in, ignored] Flags
Reserved for future use. The value is set to zero by the NL2. Drivers must ignore this parameter.
Return Value
If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. To get extended error information, call GetLastError.
Common error codes:
Error code | Meaning |
---|---|
ERROR_IO_DEVICE |
An unexpected error occurred while trying to access the device. |
Note: Custom drivers may return other error codes not listed above.
Remarks
The NL2 always calls this function from the main thread of the NL2 process.
After a successful call to this function, the specified Physical Receive Queue is expected to be stopped. It will no longer try to use any submitted buffer. If the stop operation takes time, the driver is responsible for waiting until the hardware is stopped before returning from this function.
Characteristics
Real-time requirements | ||
Deterministic behavior |
Not required |
|
Local memory allocation/deallocation restrictions | ||
Process |
External MSpace |
Internal MSpace |
System |
Not allowed |
Not allowed |
Process |
Not allowed |
Not allowed |
Contiguous memory allocation/deallocation restrictions | ||
Contiguous memory |
Not allowed |
Requirements
Minimum supported version | Header |
---|---|
eRTOS 1.0 SDK |
Rtnd.h |
See Also: