SPD_RemoveTimeOut

Purpose

Remove a timer that was created by calling SPD_AddTimeOut.

Syntax

#include "spd.h"
 
SPD_errorTP SPD_RemoveTimeOut(
   SPD_timeoutTP timer
);

Description

timer

is the identifier of the timer returned by the call to SPD_AddTimeOut.

Return Value

The return value indicates whether an error occurred, as follows:

Return

Indication

SPD_normalCN

No error

SPD_notInitializedCN

SPD_InitClient not called previously

SPD_badTimerCN

Bad timer parameter

See Also

See also the client function SPD_AddTimeOut ([xref text to replace]).