1.18.21.23 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