SpinWait.SpinUntil Method (Func<Boolean>, Int32)

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Spins until the specified condition is satisfied or until the specified timeout is expired.

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

public static bool SpinUntil(
	Func<bool> condition,
	int millisecondsTimeout
)

Parameters

condition
Type: System.Func<Boolean>

A delegate to be executed over and over until it returns true.

millisecondsTimeout
Type: System.Int32

The number of milliseconds to wait, or Infinite (-1) to wait indefinitely.

Return Value

Type: System.Boolean

True if the condition is satisfied within the timeout; otherwise, false

Exception Condition
ArgumentNullException

The condition argument is null.

ArgumentOutOfRangeException

millisecondsTimeout is a negative number other than -1, which represents an infinite time-out.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1
Return to top
Show: