Threading.CancellationToken Structure (F#)

  • Article

Represents a capability to detect cancellation of an operation.

Namespace/Module Path: System.Threading

Assembly: FSharp.Core (in FSharp.Core.dll)

[<CustomEquality>]
[<NoComparison>]
type CancellationToken =
 struct
  member this.Equals : CancellationToken -> bool
  member this.Register : Action<obj> * obj -> CancellationTokenRegistration
  member this.IsCancellationRequested :  bool
  static member ( = ) : CancellationToken * CancellationToken -> bool
  static member ( <> ) : CancellationToken * CancellationToken -> bool
 end

Remarks

This type is provided for use only with the F# Core Library Versions that targets .NET Framework 2.0. If you are using .NET Framework 4, use the .NET Framework 4 type with the same name, CancellationToken.

Instance Members

Member

Description

Equals

Equality comparison against another token.

IsCancellationRequested

Flags whether an operation should be cancelled.

Register

Registers an action to perform with the CancellationToken.

Static Members

Member

Description

( <> )

Inequality operator for tokens.

( = )

Equality operator for tokens.

Platforms

Windows 8, Windows 7, Windows Server 2012, Windows Server 2008 R2

Version Information

F# Core Library Versions

Supported in: 2.0

See Also

Reference

System.Threading Namespace (F#)