CompatibleCancellationTokenCancel Method

Cancels the operation.

Namespace: GSF.Threading
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta

Syntax

public virtual bool Cancel()

Public Overridable Function Cancel As Boolean

public:
virtual bool Cancel()

abstract Cancel : unit -> bool 
override Cancel : unit -> bool

function Cancel();

Boolean
true if the operation was cancelled; otherwise false.

Exceptions

Exception	Condition
InvalidOperationException	CancellationTokenSource not available, token cannot be cancelled.

Remarks

The token can only be cancelled if a CancellationTokenSource was provided.