nn::boss::Task::WaitFinish Member Function

Syntax

nn::Result WaitFinish(
     const nn::fnd::TimeSpan & timeout
);

Arguments

Name Description
in timeout Specifies the timeout period.

Return Values

Returns the function's execution result. Returns one of the Result values listed below.
Value Description
ResultSuccess The task completed and has the TASK_DONE or TASK_ERROR state.
ResultWaitFinishTaskNotDone The task was never instructed to start (it is in the TASK_REGISTERED state), or the task's execution was stopped (it is in the TASK_STOPPED state). Start the task again and wait for it to complete.
ResultWaitFinishTimeout The WaitFinish function timed out. Either wait again for the task to complete, or handle this some other way.
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 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

Waits for a task to finish within the specified time. This is the same as WaitFinish except that it also has a timeout feature. If the timestamp indicating when the URL was modified is the same as the previous timestamp, the task downloads nothing and fails to complete.


CONFIDENTIAL