Edit

SerCx2CustomReceiveTransactionCleanupComplete function (sercx.h)

  • Article

The SerCx2CustomReceiveTransactionCleanupComplete 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 custom-receive transaction.

Syntax

void SerCx2CustomReceiveTransactionCleanupComplete(
  [in] SERCX2CUSTOMRECEIVETRANSACTION CustomReceiveTransaction
);

Parameters

[in] CustomReceiveTransaction

A SERCX2CUSTOMRECEIVETRANSACTION handle to a custom-receive object. The serial controller driver previously called the SerCx2CustomReceiveTransactionCreate method to create this object.

Return value

None

Remarks

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

The serial controller driver must call SerCx2CustomReceiveTransactionCleanupComplete only in response to a call to the EvtSerCx2CustomReceiveTransactionCleanup function.

For more information, see SerCx2 Custom-Receive Transactions.

Requirements

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

See also

EvtSerCx2CustomReceiveTransactionCleanup

SERCX2CUSTOMRECEIVETRANSACTION

SerCx2CustomReceiveTransactionCreate