can_act

ican_act

Outline

Cancel task activation requests.

C format

 ER_UINT can_act (ID tskid);
 ER_UINT ican_act (ID tskid);
Parameter(s)

I/O

Parameter

Description

I

 ID      tskid;
ID number of the task.

TSK_SELF: Invoking task.

Value: ID number of the task.



Explanation

This service call cancels all of the activation requests queued to the task specified by parameter tskid (sets the activation request counter to 0).

When this service call is terminated normally, the number of cancelled activation requests is returned.

Note This service call does not perform status manipulation processing but performs the setting of activation request counter. Therefore, the task does not move from a state such as the READY state to the DORMANT state.

Return value

Macro

Value

Description

E_ID

-18

Invalid ID number.

- tskid < 0

- tskid > VTMAX_TSK

- When the iact_tsk was issued from a non-task, TSK_SELF was specified for tskid.

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 ican_act is issued from task or the can_act is issued from non-task, the context error is not detected and normal operation of the system is not guaranteed.

-

0

Normal completion.

- Activation request count is 0.

- Specified task is in the DORMANT state.

-

Positive value

Normal completion (activation request count).