SynchronizationContext.WaitHelper(IntPtr[], Boolean, Int32) Method

Definition

Namespace:: System.Threading

Assemblies:: mscorlib.dll, netstandard.dll, System.Threading.dll

Important

This API is not CLS-compliant.

CLS-compliant alternative: System.Threading.WaitHandle.WaitAll(WaitHandle[], TimeSpan, Boolean)

Helper function that waits for any or all the elements in the specified array to receive a signal.

protected:
 static int WaitHelper(cli::array <IntPtr> ^ waitHandles, bool waitAll, int millisecondsTimeout);

[System.CLSCompliant(false)]
[System.Security.SecurityCritical]
protected static int WaitHelper (IntPtr[] waitHandles, bool waitAll, int millisecondsTimeout);

static member WaitHelper : nativeint[] * bool * int -> int

Protected Shared Function WaitHelper (waitHandles As IntPtr(), waitAll As Boolean, millisecondsTimeout As Integer) As Integer

Parameters

waitHandles: IntPtr[]

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

waitAll: Boolean

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

millisecondsTimeout: Int32

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

Returns

Int32

The array index of the object that satisfied the wait.

Attributes: CLSCompliantAttribute SecurityCriticalAttribute

Remarks

WaitHelper is a declaration for an unmanaged external helper function. WaitHelper is called by the Wait method to wait for a signal for the specified operating system handles.

Security

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