The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

cancellation_token Class


The cancellation_token class represents the ability to determine whether some operation has been requested to cancel. A given token can be associated with a task_group, structured_task_group, or task to provide implicit cancellation. It can also be polled for cancellation or have a callback registered for if and when the associated cancellation_token_source is canceled.

class cancellation_token;

Public Methods



cancellation_token::deregister_callback Method

Removes a callback previously registered via the register method based on the cancellation_token_registration object returned at the time of registration.

cancellation_token::is_cancelable Method

Returns an indication of whether this token can be canceled or not.

cancellation_token::is_canceled Method

Returns true if the token has been canceled.

cancellation_token::none Method

Returns a cancellation token which can never be subject to cancellation.

cancellation_token::register_callback Method

Registers a callback function with the token. If and when the token is canceled, the callback will be made. Note that if the token is already canceled at the point where this method is called, the callback will be made immediately and synchronously.



Header: pplcancellation_token.h

Namespace: concurrency

© 2015 Microsoft