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

Syntax

nn::Result UpdateInterval(
u32 interval
);

Arguments

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
ResultSuccess 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 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).

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