SerCx2CustomReceiveTransactionReportProgress function (sercx.h)

Article
10/21/2021

The SerCx2CustomReceiveTransactionReportProgress method reports whether progress is being made toward completing the current custom-receive transaction.

Syntax

void SerCx2CustomReceiveTransactionReportProgress(
       SERCX2CUSTOMRECEIVETRANSACTION             CustomReceiveTransaction,
  [in] SERCX2_CUSTOM_RECEIVE_TRANSACTION_PROGRESS Progress
);

Parameters

CustomReceiveTransaction

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

[in] Progress

Whether progress is being made toward completing the custom-receive transaction. Set this parameter to one of the following enumeration constants:

SERCX2_CUSTOM_RECEIVE_NO_PROGRESS
SERCX2_CUSTOM_RECEIVE_BYTES_TRANSFERRED

For more information about these enumeration constants, see SERCX2_CUSTOM_RECEIVE_TRANSACTION_PROGRESS.

Return value

None

Remarks

To determine whether the serial controller is making progress toward completing the current custom-receive transaction, SerCx2 periodically calls the EvtSerCx2CustomReceiveTransactionQueryProgress event callback function. In response to this call, the serial controller driver calls SerCx2CustomReceiveTransactionReportProgress to provide a progress report.

Each SerCx2CustomReceiveTransactionReportProgress call reports whether any data bytes have been transferred in the current custom-receive transaction since either the previous call to this method or the start of the transaction, whichever is more recent. If one or more bytes have been transferred, the call reports that the serial controller is making progress. If no bytes have been transferred, the call reports that there is no progress.

The serial controller driver must call this method only in response to a call from SerCx2 to the EvtSerCx2CustomReceiveTransactionQueryProgress 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