T-Kernel Specification (1.B0.02)

162 CHAPTER 4. T-KERNEL/OS FUNCTIONS
tk ref mpl
Reference Variable-size Memory Pool Status
[C Language Interface]
ER ercd = tk_ref_mpl ( ID mplid, T_RMPL *pk_rmpl ) ;
[Parameters]
ID mplid Variable-size memory pool ID
T RMPL* pk rmpl Address of packet for returning status information
[Return Parameters]
ER ercd Error code
pk rmpl detail:
VP exinf Extended information
ID wtsk Waiting task information
INT frsz Free memory size (in bytes)
INT maxsz Maximum memory space size (in bytes)
(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 (mplid is invalid or cannot be used)
Object does not exist (the variable-size memory pool designated in mplid does not exist)
Parameter error (the return parameter packet address cannot be used)
[Description]
References the status of the variable-size memory pool designated in mplid, passing in return parameters
the total size of free space frsz, the maximum size of memory immediately available maxsz, waiting
task information (wtsk), and extended information (exinf).
wtsk indicates the ID of a task waiting for memory block allocation from this variable-size memory
pool. If multiple tasks are waiting for the variable-size memory pool, the ID of the task at the head of
the queue is returned. If there are no waiting tasks, wtsk = 0 is returned.
If the variable-size memory pool designated with tk ref mpl does not exist, error code E NOEXS is
returned.
Copyright c○ 2002, 2003 by T-Engine Forum
T-Kernel 1.B0.02