ReconfigureTask

nn::boss::ReconfigureTask Function

Syntax

nn::Result ReconfigureTask(
     Task * pTask,
     TaskPolicy * pPolicy,
     u8 taskStep = DEFAULT_STEP_ID
);

Parameters

Name Description
in pTask Specifies a registered task.
in pPolicy Specifies a task policy that contains updated content.
in taskStep Specifies a task step ID. (Can be omitted if there is only one task execution step)
Note: This parameter is for a feature extension, and is currently not supported. Do not specify it.

Return Values

Returns the function's result. Returns one of the Result values listed below.
Value Description
Result::IsSuccess Successfully updated.
ResultInvalidTaskId The pTask parameter is NULL.
Alternatively, the pTask parameter is uninitialized, or the pointer of the task ID specified by pTask is NULL or a zero-length string.
ResultInvalidPolicy The pPolicy parameter is NULL.
ResultInvalidTaskPriority The task execution priority specification is out of range. Confirm that it is in the range of TaskPriority.
ResultTaskPermissionOutOfRange The task permission condition is out of range.Confirm that it is in the range of TaskPermission.
ResultSchedulingPolicyOutOfRange The scheduling policy is out of range. Confirm that it is in the range of SchedulingPolicy.
ResultInvalidTaskTargetDuration The task duration is invalid. (This is for future extensibility.)
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 before using the BOSS library.
A value other than the above. Unexpected error (see boss_Result.h for error details).

Description

The property settings for registered tasks can be changed.

The properties that can be changed are only those that can be set using nn::boss::TaskPolicy.

Revision History

2010/09/16
Initial version.

CONFIDENTIAL