1.2.11.4.8 SYS_TIME_DelayIsComplete Function

bool SYS_TIME_DelayIsComplete ( SYS_TIME_HANDLE handle )

Determines if the given delay timer has completed.

This function determines if the requested delay is completed or is still in progress.

A delay request must have been created using either the SYS_TIME_DelayMS or SYS_TIME_DelayUS functions.

True - If the delay has completed.

False - If the delay has not completed.

// Check if the delay has expired.
if (SYS_TIME_DelayIsComplete(timer) != true)
{
    // Delay has not expired
}

SYS_TIME_DelayIsComplete must be called to poll the status of the delay requested through SYS_TIME_DelayMS or SYS_TIME_DelayUS.

SYS_TIME_DelayIsComplete must not be used to poll the status of a periodic timer. Status of a periodic timer may be polled using the SYS_TIME_TimerPeriodHasExpired routine.