Função SerCx2CustomReceiveTransactionReportProgress (sercx.h)

Artigo
10/30/2024

O método SerCx2CustomReceiveTransactionReportProgress relata se estão sendo feitos progressos para concluir a transação de recebimento personalizado atual.

Sintaxe

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

Parâmetros

CustomReceiveTransaction

Um identificador SERCX2CUSTOMRECEIVETRANSACTION para um objeto de recebimento personalizado. O driver do controlador serial anteriormente chamou o método SerCx2CustomReceiveTransactionCreate para criar esse objeto.

[in] Progress

Se estão sendo feitos progressos para concluir a transação de recebimento personalizado. Defina esse parâmetro como uma das seguintes constantes de enumeração:

SERCX2_CUSTOM_RECEIVE_NO_PROGRESS
SERCX2_CUSTOM_RECEIVE_BYTES_TRANSFERRED

Para obter mais informações sobre essas constantes de enumeração, consulte SERCX2_CUSTOM_RECEIVE_TRANSACTION_PROGRESS.

Valor de retorno

Nenhum

Observações

Para determinar se o controlador serial está fazendo progressos para concluir a transação de recebimento personalizado atual, o SerCx2 chama periodicamente o EvtSerCx2CustomReceiveTransactionQueryProgress função de retorno de chamada de evento. Em resposta a essa chamada, o driver do controlador serial chama SerCx2CustomReceiveTransactionReportProgress para fornecer um relatório de progresso.

Cada SerCx2CustomReceiveTransactionReportProgress relatórios de chamada se algum bytes de dados foi transferido na transação de recebimento personalizado atual desde a chamada anterior para esse método ou o início da transação, o que for mais recente. Se um ou mais bytes tiverem sido transferidos, a chamada relatará que o controlador serial está progredindo. Se nenhum bytes tiver sido transferido, a chamada informa que não há progresso.

O driver do controlador serial deve chamar esse método apenas em resposta a uma chamada de SerCx2 para a função EvtSerCx2CustomReceiveTransactionQueryProgress.

Para obter mais informações, consulte transações de Custom-Receive SerCx2.