This topic has not yet been rated - Rate this topic

ManualResetEventSlim::Wait Method (TimeSpan, CancellationToken)

.NET Framework 4.5

.NET Framework 4

Blocks the current thread until the current ManualResetEventSlim is set, using a TimeSpan to measure the time interval, while observing a CancellationToken.

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

Syntax

C++

public:
bool Wait(
	TimeSpan timeout, 
	CancellationToken cancellationToken
)

Parameters

timeout: Type: System::TimeSpan
A TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.

cancellationToken: Type: System.Threading::CancellationToken
The CancellationToken to observe.

Return Value

Type: System::Boolean
true if the ManualResetEventSlim was set; otherwise, false.

Exceptions

Exception	Condition
OperationCanceledException	cancellationToken was canceled.
ArgumentOutOfRangeException	timeout is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than MaxValue.
InvalidOperationException	The maximum number of waiters has been exceeded.
ObjectDisposedException	The object has already been disposed or the CancellationTokenSource that created cancellationToken has been disposed.

Version Information

.NET Framework

Supported in: 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Reference

ManualResetEventSlim Class

Wait Overload

System.Threading Namespace

Other Resources

ManualResetEvent and ManualResetEventSlim

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)