SerCx2CustomReceiveTransactionInitializeComplete function (sercx.h)

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

Syntax

void SerCx2CustomReceiveTransactionInitializeComplete(
  [in] SERCX2CUSTOMRECEIVETRANSACTION CustomReceiveTransaction,
  [in] BOOLEAN                        InitSuccess
);

Parameters

[in] CustomReceiveTransaction

A SERCX2CUSTOMRECEIVETRANSACTION handle to a custom-receive object. The serial controller driver previously called the SerCx2CustomReceiveTransactionCreate 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 custom-receive transaction, SerCx2 calls the EvtSerCx2CustomReceiveTransactionInitialize event callback function, if it is implemented, to initialize the serial controller to perform the transaction. In response to this call, the driver should first do any initialization that is needed; then the driver must call SerCx2CustomReceiveTransactionInitializeComplete to notify SerCx2. SerCx2 expects this notification and does not start the transaction until it is notified.

The serial controller driver must call SerCx2CustomReceiveTransactionInitializeComplete only in response to a call to the EvtSerCx2CustomReceiveTransactionInitialize function.

For more information, see SerCx2 Custom-Receive Transactions.

Requirements

See also

EvtSerCx2CustomReceiveTransactionInitialize

SERCX2CUSTOMRECEIVETRANSACTION

SerCx2CustomReceiveTransactionCreate