This topic has not yet been rated - Rate this topic

SynchronizationContext.Wait Method

.NET Framework 4

Other Versions

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)

Syntax

C++

Copy

[CLSCompliantAttribute(false)]
public virtual int Wait(
	IntPtr[] waitHandles,
	bool waitAll,
	int millisecondsTimeout
)

Parameters

waitHandles: Type: System.IntPtr[]
An array of type IntPtr that contains the native operating system handles.

waitAll: Type: System.Boolean
true to wait for all handles; false to wait for any handle.

millisecondsTimeout: 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.

Exceptions

Exception	Condition
ArgumentNullException	waitHandles is null.

Remarks

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.

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET Framework Security

SecurityCriticalAttribute
Requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Reference

SynchronizationContext Class

System.Threading Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ