UpdateInterval

nn::boss::Task::UpdateInterval Member Function

Syntax

nn::Result UpdateInterval(
     u32 interval
);

Parameters

Name Description
in interval Specifies the execution interval. The units are hours.

Return Values

Returns the function's execution result. Returns one of the Result values listed below.
Value Description
Result::IsSuccess Successfully updated the execution interval.
ResultInvalidTaskId The task ID pointer is NULL or a zero-length string.
ResultTaskNotExist The specified task ID was not found. Confirm whether it is registered yet.
ResultIpcNotSessionInitialized The session has not been initialized. This result is returned if this function is called before the Initialize function. Always call the Initialize function first thing when you use the BOSS library.
A value other than the above. Unexpected error (see boss_Result.h for error details).

Description

Updates the execution interval for a task after registration. This can be changed even after a task has been instructed to start executing.

The valid execution interval ranges from 1 to 3 hours.

Revision History

2010/09/16
Initial version.

CONFIDENTIAL