1.1.13.16 1.8.24.21 1.10.23.23 1.11.23.23 1.12.24.23 1.13.22.23 1.14.17.23 1.15.18.23 1.16.25.23 1.17.20.23 1.18.21.23 1.19.21.23 1.20.25.23 1.21.26.23 1.22.28.23 1.23.27.23 1.24.23.23 1.27.26.21 1.34.26.21 1.35.20.21 UARTx_ReadAbort Function

C

/* x = UART instance number */

/* Non-blocking mode */

bool UARTx_ReadAbort(void)

Summary

Aborts the ongoing read request

Description

This API lets the application abort an ongoing read request. If needed, the application can call the UARTx_ReadCountGet API to know the number of bytes successfully read before issuing the UARTx_ReadAbort API.

Precondition

UARTx_Initialize must have been called for the associated UART instance.

Parameters

None

Returns

true - operation is successful

false - error during execution

Example

bool timeout;

if (timeout == true)
{
    // Kill the ongoing read read request
    UART1_ReadAbort();
}

Remarks

None