is_task_cancellation_requested Function

Returns an indication of whether the task that is currently executing has received a request to cancel its execution. Cancellation is requested on a task if the task was created with a cancellation token, and the token source associated with that token is canceled.

inline bool __cdecl is_task_cancellation_requested();

true if the currently executing task has received a request for cancellation, false otherwise.

If you call this method in the body of a task and it returns true, you must respond with a call to cancel_current_task to acknowledge the cancellation request, after performing any cleanup you need. This will abort the execution of the task and cause it to enter into the canceled state. If you do not respond and continue execution, or return instead of calling cancel_current_task, the task will enter the completed state when it is done. state.

A task is not cancellable if it was created without a cancellation token.

Header: ppltasks.h

Namespace: concurrency

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2015 Microsoft