SPD_AddTimeOut

Purpose

Register a callback that is invoked after a specified period of time has elapsed.

Syntax

#include "spd.h"
 
SPD_timeoutTP SPD_AddTimeOut(
   int interval,
   SPD_timeoutCallbackTP callback,
   SPD_passbackTP passback
);

Description

interval

is the time in milliseconds that must elapse before the callback is invoked.

callback

is the callback function that is invoked after the timeout period has elapsed. The callback function is described in 8.2.

passback

is a value passed to the callback function.

Return Value

This function returns an identifier for the timer, which is supplied as a parameter to the callback when it is invoked, and which you may use to remove the timer in a call to SPD_RemoveTimeOut.

This function returns NULL if it could not register a callback.

See Also

See also the following client functions:

Use of this function is illustrated in 6.5.