RtndExtractRxBuffer

RtndExtractRxBuffer extracts a filled buffer from the specified Receive Queue.

Syntax

BOOL RtndExtractRxBuffer(
  [in]            ULONG_PTR RtndInterfaceId,
  [in]            ULONG RxQueueIndex,
  [in]            VOID *pRxQueueAppContext,
  [out]           RTND_BUFFER_HEADER **pBufferHeader,
  [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] pRxQueueAppContext

The address of the context returned when the calling process called RtndAttachRxQueue.

[out] pBufferHeader

The address of the extracted buffer header.

[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:

Note: Custom drivers may return other error codes not listed above.

Remarks

This function may be called from any process.

Characteristics

Requirements

See Also:

• RTND_BUFFER_HEADER
• RtndAttachRxQueue
• RtndManageInterface