TaskManager::AbandonTask

TaskManager::AbandonTask
virtual bool AbandonTask(Task* ptask) = 0;
Description

AbandonTask instructs the task manager to abandon the task which was previously added to the queue. This function will abandon the task if it is not yet dispatched for execution and returns true. If task is already dispatched for execution or never added to the manager, the method should return false. Implementation of AbandonTask will also call ptask->OnAbandon with an appropriate argument.

Parameters
Parameters 
Description 
Task* ptask 
Pointer to the task which is to be abandoned. 
Return Value

A Boolean value of true if the task is abandoned or false if the task is already dispatched for execution or never added to the manager.