T-Kernel Specification (1.B0.02)

182 CHAPTER 4. T-KERNEL/OS FUNCTIONS
tk ref alm
Reference Alarm Handler Status
[C Language Interface]
ER ercd = tk_ref_alm ( ID almid, T_RALM *pk_ralm ) ;
[Parameters]
ID almid Alarm handler ID
T RALM* pk ralm Address of packet for returning status information
[Return Parameters]
ER ercd Error code
pk ralm detail:
VP exinf Extended information
RELTIM lfttim Time remaining until the handler starts
UINT almstat Alarm handler activation state
(Other implementation-dependent parameters may be added beyond this point.)
[Error Codes]
E OK
E ID
E NOEXS
E PAR
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)
Parameter error (the return parameter packet address cannot be used)
[Description]
References the status of the alarm handler designated in almno, passing in return parameters the time
remaining until the handler starts lfttim, and extended information exinf.
The following information is returned in almstat.
almstat:= (TALM_STP | TALM_STA)
TALM STP
TALM STA
Thg alarm handler is inactive
The alarm handler is active
#define TALM_STP 0x00 /* alarm handler is inactive */
#define TALM_STA 0x01 /* alarm handler is active */
Copyright c○ 2002, 2003 by T-Engine Forum
T-Kernel 1.B0.02