ploc_mtx

Outline

Lock mutex (polling).

C format

 ER      ploc_mtx (ID mtxid);

Parameter(s)

I/O	Parameter	Description
I	ID mtxid;	ID number of the mutex to be locked.

Explanation

This service call locks the mutex specified by parameter mtxid.

If the target mutex could not be locked (another task has been locked) when this service call is issued but E_TMOUT is returned.

Note In the RI850V4, E_ILUSE is returned if this service call is re-issued for the mutex that has been locked by the invoking task (multiple-locking of mutex).

Return value

Macro	Value	Description
E_OK	0	Normal completion.
E_ID	-18	Invalid ID number. - mtxid < 0x0 - mtxid > Maximum ID number
E_CTX	-25	Context error. - This service call was issued from a non-task. - This service call was issued in the CPU locked state.
E_ILUSE	-28	Illegal service call use. - Multiple locking of a mutex.
E_NOEXS	-42	Non-existent object. - Specified mutex is not registered.
E_TMOUT	-50	Polling failure. - The target mutex has been locked by another task.