SerCx2CustomTransmitTransactionCleanupComplete function (sercx.h)

Article
02/22/2024

The SerCx2CustomTransmitTransactionCleanupComplete method notifies 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 custom-transmit transaction.

Syntax

void SerCx2CustomTransmitTransactionCleanupComplete(
  [in] SERCX2CUSTOMTRANSMITTRANSACTION CustomTransmitTransaction
);

Parameters

[in] CustomTransmitTransaction

A SERCX2CUSTOMTRANSMITTRANSACTION handle to a custom-transmit object. The serial controller driver previously called the SerCx2CustomTransmitTransactionCreate method to create this object.

Return value

None

Remarks

After a custom-transmit transaction ends, SerCx2 calls the EvtSerCx2CustomTransmitTransactionCleanup 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 SerCx2CustomTransmitTransactionCleanupComplete to notify SerCx2. SerCx2 expects this notification and does not start the next transaction until it is notified.

A serial controller driver must call SerCx2CustomTransmitTransactionCleanupComplete only in response to a call to the EvtSerCx2CustomTransmitTransactionCleanup function.

For more information, see SerCx2 Custom-Transmit Transactions.

Requirements

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