CancellationTokenSource Class (System.Threading)

Switch View

Collapse All

.NET Framework Class Library

CancellationTokenSource Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Signals to a CancellationToken that it should be canceled.

Namespace: System.Threading
Assembly: mscorlib (in mscorlib.dll)

Syntax

Visual Basic (Declaration)

<ComVisibleAttribute(False)> _
<HostProtectionAttribute(SecurityAction.LinkDemand, Synchronization := True,  _
    ExternalThreading := True)> _
Public NotInheritable Class CancellationTokenSource _
    Implements IDisposable

Visual Basic (Usage)

Dim instance As CancellationTokenSource

[ComVisibleAttribute(false)]
[HostProtectionAttribute(SecurityAction.LinkDemand, Synchronization = true, 
    ExternalThreading = true)]
public sealed class CancellationTokenSource : IDisposable

Visual C++

[ComVisibleAttribute(false)]
[HostProtectionAttribute(SecurityAction::LinkDemand, Synchronization = true, 
    ExternalThreading = true)]
public ref class CancellationTokenSource sealed : IDisposable

[<SealedAttribute>]
[<ComVisibleAttribute(false)>]
[<HostProtectionAttribute(SecurityAction.LinkDemand, Synchronization = true, 
    ExternalThreading = true)>]
type CancellationTokenSource =  
    class
        interface IDisposable
    end

Remarks

Note
The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: Synchronization \| ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

Note

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: Synchronization | ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

Inheritance Hierarchy

System..::.Object
System.Threading..::.CancellationTokenSource

Thread Safety

All public and protected members of CancellationTokenRegistration are thread-safe and may be used concurrently from multiple threads, with the exception of Dispose, which must only be used when all other operations on the CancellationTokenRegistration have completed.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Reference

CancellationTokenSource Members

System.Threading Namespace

Other Resources

Cancellation