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

Reference

Definition

Namespace:: System.Threading

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

Assembly:: System.Threading.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Source:: SynchronizationContext.cs

Source:: SynchronizationContext.cs

Source:: SynchronizationContext.cs

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.

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)]
protected static int WaitHelper(IntPtr[] waitHandles, bool waitAll, int millisecondsTimeout);

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

[<System.CLSCompliant(false)>]
static member WaitHelper : nativeint[] * bool * int -> int

[<System.CLSCompliant(false)>]
[<System.Security.SecurityCritical>]
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.

Applies to

Product	Versions
.NET	Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0, 2.1

Share via