Development Tools

del_mbx

Outline

Delete mailbox.

C format

 ER      del_mbx (ID mbxid);

Parameter(s)


I/O	Parameter	Description
I	ID mbxid;	ID number of the mailbox.

Explanation

This service call can be called from tasks that belong to Trusted Domain.

This service call deletes the mailbox indicated by mbxid.

When there are waiting tasks for the target mailbox by using rcv_mbx or trcv_mbx, this service call cancels the WAITING state of the tasks and returns E_DLT as a return value of the rcv_mbx or trcv_mbx.

Return value


Macro	Value	Description
E_OK	0	Normal completion.
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 from non-task. - This service call was issued in the status "PSW.IPL > kernel interrupt mask level".
E_MACV	-26	Memory access violation. - Stack pointer points out of user stack for invoking task.
E_OACV	-27	Object access violation. - The invoking task does not belong to trusted domain.
E_NOEXS	-42	Non-existent object. - The mailbox specified by mbxid does not exist.