SerCx2PioReceiveInitializeTransactionComplete function (sercx.h)

Article
02/22/2024

The SerCx2PioReceiveInitializeTransactionComplete method notifies version 2 of the serial framework extension (SerCx2) that the serial driver has finished initializing the serial controller hardware in preparation for a new PIO-receive transaction.

Syntax

void SerCx2PioReceiveInitializeTransactionComplete(
  [in] SERCX2PIORECEIVE PioReceive,
  [in] BOOLEAN          InitSuccess
);

Parameters

[in] PioReceive

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

[in] InitSuccess

Whether the initialization was successful. If TRUE, the initialization succeeded. If FALSE, the initialization failed.

Return value

None

Remarks

Before SerCx2 starts a PIO-receive transaction, SerCx2 calls the EvtSerCx2PioReceiveInitializeTransaction event callback function, if it is implemented, to initialize the serial controller hardware. In response to this call, the driver should first do any initialization that is needed; then the driver must call SerCx2PioReceiveInitializeTransactionComplete to notify SerCx2. SerCx2 expects this notification and does not start the transaction until it is notified.

The serial controller driver must call SerCx2PioReceiveInitializeTransactionComplete only in response to a call to the EvtSerCx2PioReceiveInitializeTransaction 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