is_task_cancellation_requested Function
TOC
Collapse the table of content
Expand the table of content

is_task_cancellation_requested Function

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

bool __cdecl is_task_cancellation_requested();

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

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 you perform any cleanup that's required. This aborts the execution of the task and causes it to enter into the canceled state. If you don't respond and continue execution, or return instead of calling cancel_current_task, the task enters the completed state when it is done.

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

Header: ppltasks.h

Namespace: concurrency

Show:
© 2016 Microsoft