Everything

stp_alm

istp_alm

Outline
Stop alarm handler operation.
C format
 ER      stp_alm (ID almid);
 ER      istp_alm (ID almid);
Parameter(s)
I/O
Parameter
Description
I
 ID      almid;
ID number of the alarm handler.

Explanation
This service call moves the alarm handler specified by parameter almid from the operational state (STA state) to non-operational state (STP state).
As a result, the target alarm handler is excluded from activation targets of the RI600PX until issuance of sta_alm or ista_alm.
Note This service call does not perform queuing of stop requests. If the target alarm handler has been moved to the non-operational state (STP state), therefore, no processing is performed but it is not handled as an error.
Return value
Macro
Value
Description
E_OK
0
Normal completion.
E_ID
-18
Invalid ID number.
- almid < 0
- almid > VTMAX_ALH
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 istp_alm is issued from task or the stp_alm is issued from non-task, the context error is not detected and normal operation of the system is not guaranteed.
E_NOEXS
-42
Non-existent object.
- The alarm handler specified by almid does not exist.