ref_mbx

Outline

Reference mailbox state.

C format

 ER      ref_mbx ( ID mbxid, T_RMBX *pk_rmbx );


Assembly format

 MOVW    BC, #LOWW(_pk_rmbx)
 MOV     A,  #mbxid
 CALL    !!_ref_mbx


Parameter(s)

I/O

Parameter

Description

I

 ID      mbxid;
ID number of the mailbox to be referenced.

O

 T_RMBX  *pk_rmbx;
Pointer to the packet returning the mailbox state.



Explanation

Stores mailbox state packet (such as existence of waiting tasks) of the mailbox specified by parameter mbxid in the area specified by parameter pk_rmbx.

Note For details about the mailbox state packet, refer to "12.5.6 Mailbox state packet".

Return value

Macro

Value

Description

E_OK

0

Normal completion.