SerCx2PioReceiveCleanupTransactionComplete function (sercx.h)

Article
10/21/2021

The SerCx2PioReceiveCleanupTransactionComplete method informs version 2 of the serial framework extension (SerCx2) that the serial controller driver has finished cleaning up the serial controller's hardware state after a PIO-receive transaction.

Syntax

void SerCx2PioReceiveCleanupTransactionComplete(
  [in] SERCX2PIORECEIVE PioReceive
);

Parameters

[in] PioReceive

A SERCX2PIORECEIVE handle to a PIO-receive object. The serial controller driver previously called the SerCx2PioReceiveCreate method to create this object.

Return value

None

Remarks

After a PIO-receive transaction ends, SerCx2 calls the EvtSerCx2PioReceiveCleanupTransaction event callback function, if it is implemented, to clean up the serial controller state. In response to this call, the driver should first do any clean-up work that is needed; then the driver must call SerCx2PioReceiveCleanupTransactionComplete to notify SerCx2. SerCx2 expects this notification and does not start the next transaction until it is notified.

The serial controller driver must call SerCx2PioReceiveCleanupTransactionComplete only in response to a call to the EvtSerCx2PioReceiveCleanupTransaction function.

For more information, see SerCx2 PIO-Receive Transactions.

Requirements

Requirement	Value
Minimum supported client	Available starting with Windows 8.1.
Target Platform	Universal
Header	sercx.h
IRQL	<= DISPATCH_LEVEL