TimerSignalAtTime
Sends a signal at the specified time.
Synopsis
TimerHandle TimerSignalAtTime (int32 signal, uint32 seconds, uint32 microseconds)
Description
This function creates a timer that notifies you by signal at the specified time. The timer is a one-shot; after sending a notification message the timer enters a suspended state. Use TimerReset()
to reactivate the timer using new time values, or TimerCancel()
to delete the timer.
AtTime signals are useful primarily for synchronizing with real-world events. For a one-shot delay use TimerSignalDelay()
. For a periodic series of signals, use TimerSignalHeartbeat()
.
The TimerServices thread must be active before calling this function.
Arguments
- signal
- Signal to send to your task.
- seconds
- Seconds portion of the time.
- microseconds
- Microseconds portion of the time. This value can be larger than 1 million.
Return Value
A TimerHandle (a positive value) on success or a negative error code.
Implementation
Library call implemented in lib3do.lib.
Associated Files
lib3do.lib, timerutils.h
See Also
TimerSignalAfterDelay
, TimerSignalHeartbeat