Share via


IAccountManagerFuture.Cancel(Boolean) Method

Definition

Attempts to cancel execution of this task.

[Android.Runtime.Register("cancel", "(Z)Z", "GetCancel_ZHandler:Android.Accounts.IAccountManagerFutureInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]
public bool Cancel (bool mayInterruptIfRunning);
[<Android.Runtime.Register("cancel", "(Z)Z", "GetCancel_ZHandler:Android.Accounts.IAccountManagerFutureInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]
abstract member Cancel : bool -> bool

Parameters

mayInterruptIfRunning
Boolean

true if the thread executing this task should be interrupted; otherwise, in-progress tasks are allowed to complete

Returns

false if the task could not be cancelled, typically because it has already completed normally; true otherwise

Attributes

Remarks

Attempts to cancel execution of this task. This attempt will fail if the task has already completed, has already been cancelled, or could not be cancelled for some other reason. If successful, and 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 should be interrupted in an attempt to stop the task.

After this method returns, subsequent calls to #isDone will always return true. Subsequent calls to #isCancelled will always return true if this method returned true.

Java documentation for android.accounts.AccountManagerFuture.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.

Applies to