IFuture.Cancel(Boolean) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Attempts to cancel execution of this task.
[Android.Runtime.Register("cancel", "(Z)Z", "GetCancel_ZHandler:Java.Util.Concurrent.IFutureInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]
public bool Cancel (bool mayInterruptIfRunning);[<Android.Runtime.Register("cancel", "(Z)Z", "GetCancel_ZHandler:Java.Util.Concurrent.IFutureInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]
abstract member Cancel : bool -> boolParameters
- mayInterruptIfRunning
- Boolean
true if the thread
executing this task should be interrupted (if the thread is
known to the implementation); otherwise, in-progress tasks are
allowed to complete
Returns
false if the task could not be cancelled,
typically because it has already completed; true
otherwise. If two or more threads cause a task to be cancelled,
then at least one of them returns true. Implementations
may provide stronger guarantees.
- Attributes
Remarks
Attempts to cancel execution of this task. This method has no effect if the task is already completed or cancelled, or could not be cancelled for some other reason. Otherwise, if this task has not started when cancel is called, this task should never run. If the task has already started, then the mayInterruptIfRunning parameter determines whether the thread executing this task (when known by the implementation) is interrupted in an attempt to stop the task.
The return value from this method does not necessarily indicate whether the task is now cancelled; use #isCancelled.
Java documentation for java.util.concurrent.Future.cancel(boolean).
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.