nn::boss::Task::StartImmediate Member Functionnn::Result StartImmediate( void );
None.
Result values listed below. | Value | Description |
|---|---|
ResultSuccess |
Successfully issued instruction to start task immediately. |
ResultInvalidTaskId |
The task ID pointer is NULL or a zero-length string. |
ResultTaskNotExist |
The specified task ID was not found. Confirm whether it has already been registered. |
ResultIpcNotSessionInitialized |
Either the session had not been initialized or there were incompatible permissions. This Result value is returned if you call this function before Initialize or InitializePrivileged. Always call Initialize or InitializePrivileged first when you use the BOSS library. |
| A value other than the above. | Unexpected error (see boss_Result.h for details). |
Starts a task immediately. This can only be called after infrastructure connections are enabled. Because this allows a task to be executed before its scheduled time, it is suitable for immediately executing background tasks as necessary. Note, however, that because a task's execution priority is taken from attribute values when it is registered, other high-priority tasks may be executed first. The Start function differs from this one in that its execution time has already arrived and, if communications are interrupted, it does not enter the "resume" state but instead results in an error. As a precaution, set the execution count equal to 1 to run the target task alone only once. If you set a value greater than 1, the task will automatically run in the background until its execution count is zero, just like normal tasks. See ac::Connect for information about how to enable infrastructure connections.
CONFIDENTIAL