CountdownEvent.Wait Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Blocks the current thread until the CountdownEvent is set.
Overloads
| Wait() |
Blocks the current thread until the CountdownEvent is set. |
| Wait(Int32) |
Blocks the current thread until the CountdownEvent is set, using a 32-bit signed integer to measure the timeout. |
| Wait(CancellationToken) |
Blocks the current thread until the CountdownEvent is set, while observing a CancellationToken. |
| Wait(TimeSpan) |
Blocks the current thread until the CountdownEvent is set, using a TimeSpan to measure the timeout. |
| Wait(Int32, CancellationToken) |
Blocks the current thread until the CountdownEvent is set, using a 32-bit signed integer to measure the timeout, while observing a CancellationToken. |
| Wait(TimeSpan, CancellationToken) |
Blocks the current thread until the CountdownEvent is set, using a TimeSpan to measure the timeout, while observing a CancellationToken. |
Wait()
- Source:
- CountdownEvent.cs
- Source:
- CountdownEvent.cs
- Source:
- CountdownEvent.cs
Blocks the current thread until the CountdownEvent is set.
public:
void Wait();public void Wait ();[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public void Wait ();member this.Wait : unit -> unit[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
member this.Wait : unit -> unitPublic Sub Wait ()- Attributes
Exceptions
The current instance has already been disposed.
Remarks
The caller of this method blocks indefinitely until the current instance is set. The caller will return immediately if the event is currently in a set state.
See also
Applies to
Wait(Int32)
- Source:
- CountdownEvent.cs
- Source:
- CountdownEvent.cs
- Source:
- CountdownEvent.cs
Blocks the current thread until the CountdownEvent is set, using a 32-bit signed integer to measure the timeout.
public:
bool Wait(int millisecondsTimeout);public bool Wait (int millisecondsTimeout);[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public bool Wait (int millisecondsTimeout);member this.Wait : int -> bool[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
member this.Wait : int -> boolPublic Function Wait (millisecondsTimeout As Integer) As BooleanParameters
Returns
true if the CountdownEvent was set; otherwise, false.
- Attributes
Exceptions
The current instance has already been disposed.
millisecondsTimeout is a negative number other than -1, which represents an infinite time-out.
See also
Applies to
Wait(CancellationToken)
- Source:
- CountdownEvent.cs
- Source:
- CountdownEvent.cs
- Source:
- CountdownEvent.cs
Blocks the current thread until the CountdownEvent is set, while observing a CancellationToken.
public:
void Wait(System::Threading::CancellationToken cancellationToken);public void Wait (System.Threading.CancellationToken cancellationToken);[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public void Wait (System.Threading.CancellationToken cancellationToken);member this.Wait : System.Threading.CancellationToken -> unit[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
member this.Wait : System.Threading.CancellationToken -> unitPublic Sub Wait (cancellationToken As CancellationToken)Parameters
- cancellationToken
- CancellationToken
The CancellationToken to observe.
- Attributes
Exceptions
cancellationToken has been canceled.
The current instance has already been disposed.
-or-
The CancellationTokenSource that created cancellationToken has already been disposed.
Remarks
The caller of this method blocks indefinitely until the current instance is set. The caller will return immediately if the event is currently in a set state. If the CancellationToken being observed is canceled during the wait operation, an OperationCanceledException will be thrown.
See also
Applies to
Wait(TimeSpan)
- Source:
- CountdownEvent.cs
- Source:
- CountdownEvent.cs
- Source:
- CountdownEvent.cs
Blocks the current thread until the CountdownEvent is set, using a TimeSpan to measure the timeout.
public:
bool Wait(TimeSpan timeout);public bool Wait (TimeSpan timeout);[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public bool Wait (TimeSpan timeout);member this.Wait : TimeSpan -> bool[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
member this.Wait : TimeSpan -> boolPublic Function Wait (timeout As TimeSpan) As BooleanParameters
- timeout
- TimeSpan
A TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.
Returns
true if the CountdownEvent was set; otherwise, false.
- Attributes
Exceptions
The current instance has already been disposed.
timeout is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than Int32.MaxValue.
See also
Applies to
Wait(Int32, CancellationToken)
- Source:
- CountdownEvent.cs
- Source:
- CountdownEvent.cs
- Source:
- CountdownEvent.cs
Blocks the current thread until the CountdownEvent is set, using a 32-bit signed integer to measure the timeout, while observing a CancellationToken.
public:
bool Wait(int millisecondsTimeout, System::Threading::CancellationToken cancellationToken);public bool Wait (int millisecondsTimeout, System.Threading.CancellationToken cancellationToken);[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public bool Wait (int millisecondsTimeout, System.Threading.CancellationToken cancellationToken);member this.Wait : int * System.Threading.CancellationToken -> bool[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
member this.Wait : int * System.Threading.CancellationToken -> boolPublic Function Wait (millisecondsTimeout As Integer, cancellationToken As CancellationToken) As BooleanParameters
- cancellationToken
- CancellationToken
The CancellationToken to observe.
Returns
true if the CountdownEvent was set; otherwise, false.
- Attributes
Exceptions
cancellationToken has been canceled.
The current instance has already been disposed. -or- The CancellationTokenSource that created cancellationToken has already been disposed.
millisecondsTimeout is a negative number other than -1, which represents an infinite time-out.
See also
Applies to
Wait(TimeSpan, CancellationToken)
- Source:
- CountdownEvent.cs
- Source:
- CountdownEvent.cs
- Source:
- CountdownEvent.cs
Blocks the current thread until the CountdownEvent is set, using a TimeSpan to measure the timeout, while observing a CancellationToken.
public:
bool Wait(TimeSpan timeout, System::Threading::CancellationToken cancellationToken);public bool Wait (TimeSpan timeout, System.Threading.CancellationToken cancellationToken);[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public bool Wait (TimeSpan timeout, System.Threading.CancellationToken cancellationToken);member this.Wait : TimeSpan * System.Threading.CancellationToken -> bool[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
member this.Wait : TimeSpan * System.Threading.CancellationToken -> boolPublic Function Wait (timeout As TimeSpan, cancellationToken As CancellationToken) As BooleanParameters
- timeout
- TimeSpan
A TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.
- cancellationToken
- CancellationToken
The CancellationToken to observe.
Returns
true if the CountdownEvent was set; otherwise, false.
- Attributes
Exceptions
cancellationToken has been canceled.
The current instance has already been disposed. -or- The CancellationTokenSource that created cancellationToken has already been disposed.
timeout is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than Int32.MaxValue.
