T-Kernel Specification (1.B0.02)

4.7. TIME MANAGEMENT FUNCTIONS 175
tk ref cyc
Reference Cyclic Handler Status
[C Language Interface]
ER ercd = tk_ref_cyc ( ID cycid, T_RCYC *pk_rcyc ) ;
[Parameters]
ID cycid Cyclic handler ID
T RCYC* pk rcyc Address of packet for returning status information
[Return Parameters]
ER ercd Error code
pk rcyc detail:
VP exinf Extended information
RELTIM lfttim Time remaining until the next start time
UINT cycstat Cyclic 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 (cycid is invalid or cannot be used)
Object does not exist (the cyclic handler designated in cycid does not exist)
Parameter error (the return parameter packet address cannot be used)
[Description]
References the status of the cyclic handler designated in cycid, passing in return parameters the cyclic
handler activation state cycstat, the time remaining until the next start lfttim, and extended information
exinf.
The following information is returned in cycstat.
cycstat:= (TCYC_STP | TCYC_STA)
TCYC STP
TCYC STA
The cyclic handler is inactive
The cyclic handler is active
#define TCYC_STP 0x00 /* cyclic handler is inactive */
#define TCYC_STA 0x01 /* cyclic handler is active */
If the cyclic handler designated in cycid does not exist, error code E NOEXS is returned.
Copyright c○ 2002, 2003 by T-Engine Forum
T-Kernel 1.B0.02