SynchronizationContext::Wait Method (array<IntPtr>^, Boolean, Int32)

.NET Framework (current version)

clsCompliantAlternativeM:System.Threading.WaitHandle.WaitAll(System.Threading.WaitHandle[],System.TimeSpan,System.Boolean)

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

This API is not CLS-compliant.

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

Syntax

C++

public:
[SecurityCriticalAttribute]
[CLSCompliantAttribute(false)]
virtual int Wait(
	array<IntPtr>^ waitHandles,
	bool waitAll,
	int millisecondsTimeout
)

Parameters

waitHandles: Type: array<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.

Security

SecurityCriticalAttribute

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

Version Information

.NET Framework
Available since 2.0