TipcEventGetInterval

Name

TipcEventGetInterval — get a timer event’s time interval

Synopsis

T_BOOL TipcEventGetInterval(event, interval_return) 
T_IPC_EVENT event; 
T_REAL8 *interval_return; 

Arguments

event — a timer event

interval_return — returned interval, in seconds

Return Values

TRUE if the interval was successfully retrieved for the event, FALSE otherwise.

Diagnostics

If TipcEventGetInterval fails, it returns FALSE and sets the global SmartSockets error number to one of:

Description

TipcEventGetInterval returns the time interval of a timer event.

Caution

None

See Also

TipcEventCreateTimer, TipcEventSetInterval

Examples

This example returns the time interval of a timer event.

T_REAL8 interval; 
 
if (!TipcEventGetInterval(event, &interval)) { 
  return;  /* error */ 
}