T-Kernel Specification (1.B0.02)

180 CHAPTER 4. T-KERNEL/OS FUNCTIONS
tk sta alm
Start Alarm Handler
[C Language Interface]
ER ercd = tk_sta_alm ( ID almid, RELTIM almtim ) ;
[Parameters]
ID almid Alarm handler ID
RELTIM almtim Alarm handler start time (alarm time)
[Return Parameters]
ER ercd Error code
[Error Codes]
E OK
E ID
E NOEXS
Normal completion
Invalid ID number (almid is invalid or cannot be used)
Object does not exist (the alarm handler designated in almid does not exist)
[Description]
Sets the alarm time of the alarm handler designated in almid to the time given in almtim, putting the
alarm handler in active state. almtim is designated as relative time from the time of calling tk sta alm.
After the time designated in almtim has elapsed, the alarm handler starts. If the alarm handler is
already active when this system call is invoked, the existing almtim setting is canceled and the alarm
handler is activated anew with the alarm time designated here.
If almtim = 0 is set, the alarm handler starts as soon as it is activated.
Copyright c○ 2002, 2003 by T-Engine Forum
T-Kernel 1.B0.02