This documentation is archived and is not being maintained.

SynchronizationContext.Wait Method

Waits for any or all the elements in the specified array to receive a signal.

This API is not CLS-compliant. The CLS-compliant alternative is WaitAll(WaitHandle(), TimeSpan, Boolean).

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

<CLSCompliantAttribute(False)> _
<SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags := SecurityPermissionFlag.NoFlags Or SecurityPermissionFlag.ControlEvidence Or SecurityPermissionFlag.ControlPolicy)> _
Public Overridable Function Wait ( _
	waitHandles As IntPtr(), _
	waitAll As Boolean, _
	millisecondsTimeout As Integer _
) As Integer
Dim instance As SynchronizationContext 
Dim waitHandles As IntPtr()
Dim waitAll As Boolean 
Dim millisecondsTimeout As Integer 
Dim returnValue As Integer 

returnValue = instance.Wait(waitHandles, _
	waitAll, millisecondsTimeout)


Type: System.IntPtr()

An array of type IntPtr that contains the native operating system handles.

Type: System.Boolean

true to wait for all handles; false to wait for any handle.

Type: System.Int32

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

Return Value

Type: System.Int32
The array index of the object that satisfied the wait.

The Wait method calls the external declaration WaitHelper to perform the wait activity. Override the Wait method to change the wait behavior for the synchronization context.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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.

.NET Framework

Supported in: 3.5, 3.0, 2.0