nn::boss::ReconfigureTask Function

Syntax

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

Arguments

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. (May be omitted if there is only one task step to be executed)

Return Values

Returns the function's execution result. Returns one of the Result values listed below.
Value Description
ResultSuccess Successfully updated.
ResultInvalidTaskId The task ID pointer is NULL or a zero-length string.
ResultInvalidPolicy The policy information pointer is NULL.
ResultInvalidTaskPriolity The task priority specification is out-of-range. Confirm that it is in the range of TaskPriority.
ResultTaskPermissionOutOfRange The task permission information 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 Either the session is not initialized or there are incompatible permissions. This Result is returned if this function is called before the Initialize or the InitializePriviledged function is called. Always call the Initialize or InitializePrivileged function first when you use the BOSS library.
A value other than the above. Unexpected error (see boss_Result.h for error details).

Description

Updates the policy of a task previously registered to the library.

Revision History

2010/09/16
Initial version.

CONFIDENTIAL