prcv_mbx

iprcv_mbx

Outline

Receive from mailbox (polling).

C format

 ER      prcv_mbx (ID mbxid, T_MSG **ppk_msg);

 ER      iprcv_mbx (ID mbxid, T_MSG **ppk_msg);

Parameter(s)

I/O	Parameter	Description
I	ID mbxid;	ID number of the mailbox.
O	T_MSG **ppk_msg;	Start address of the message packet received from the mailbox.

[M[Message packet T_MSG for TA_MFIFO attribute ]

typedef struct { VP msghead; /*RI600PX management area*/ } T_MSG;

[Message packet T_MSG_PRI for TA_MPRI attribute]

typedef struct { T_MSG msgque; /*Message header*/ PRI msgpri; /*Message priority*/ } T_MSG_PRI;

Explanation

This service call receives a message from the mailbox specified by parameter mbxid, and stores its start address in the area specified by parameter ppk_msg.

If the message could not be received from the target mailbox (no messages were queued in the wait queue) when this service call is issued, message reception processing is not executed but "E_TMOUT" is returned.

Return value

Macro	Value	Description
E_OK	0	Normal completion.
E_PAR	-17	parameter error. - ppk_msg == NULL
E_ID	-18	Invalid ID number. - mbxid < 0 - mbxid > VTMAX_MBX
E_CTX	-25	Context error. - This service call was issued in the CPU locked state. - This service call was issued in the status "PSW.IPL > kernel interrupt mask level". Note When the iprcv_mbx is issued from task or the prcv_mbx is issued from non-task, the context error is not detected and normal operation of the system is not guaranteed.
E_MACV	-26	Memory access violation. (only for prcv_mbx) - The operand-write access to the area indicated by ppk_msg has not been permitted to the invoking task.
E_NOEXS	-42	Non-existent object. - The mailbox specified by mbxid does not exist.
E_TMOUT	-50	Polling failure.