CommonMessagePump.ModalWaitForHandles Method

Definition

Namespace:

Microsoft.VisualStudio.Shell

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Package:

Microsoft.VisualStudio.Shell.15.0 v17.11.40262

Overloads

ModalWaitForHandles(WaitHandle[], Int32)	Blocks the current thread by pumping messages until either a timeout or one of the specified handles has been signaled.
ModalWaitForHandles(WaitHandle[], IVsCommonMessagePumpClientEvents)	Blocks the current thread by pumping messages until either a timeout or one of the specified handles has been signaled.
ModalWaitForHandles(WaitHandle)	Blocks the current thread by pumping messages until either a timeout or the specified handle has been signaled.

ModalWaitForHandles(WaitHandle[], Int32)

Blocks the current thread by pumping messages until either a timeout or one of the specified handles has been signaled.

public:
 Microsoft::VisualStudio::Shell::CommonMessagePumpExitCode ModalWaitForHandles(cli::array <System::Threading::WaitHandle ^> ^ waitHandles, [Runtime::InteropServices::Out] int % handleSignaledIndex);

public Microsoft.VisualStudio.Shell.CommonMessagePumpExitCode ModalWaitForHandles (System.Threading.WaitHandle[] waitHandles, out int handleSignaledIndex);

member this.ModalWaitForHandles : System.Threading.WaitHandle[] * int -> Microsoft.VisualStudio.Shell.CommonMessagePumpExitCode

Public Function ModalWaitForHandles (waitHandles As WaitHandle(), ByRef handleSignaledIndex As Integer) As CommonMessagePumpExitCode

Parameters

waitHandles

WaitHandle[]

The handles

handleSignaledIndex

Int32

Index to the handle that was signaled.

Returns

CommonMessagePumpExitCode

An exit code indicating why the wait ended.

ModalWaitForHandles(WaitHandle[], IVsCommonMessagePumpClientEvents)

Blocks the current thread by pumping messages until either a timeout or one of the specified handles has been signaled.

public:
 Microsoft::VisualStudio::Shell::CommonMessagePumpExitCode ModalWaitForHandles(cli::array <System::Threading::WaitHandle ^> ^ waitHandles, Microsoft::VisualStudio::Shell::Interop::IVsCommonMessagePumpClientEvents ^ client);

public Microsoft.VisualStudio.Shell.CommonMessagePumpExitCode ModalWaitForHandles (System.Threading.WaitHandle[] waitHandles, Microsoft.VisualStudio.Shell.Interop.IVsCommonMessagePumpClientEvents client);

member this.ModalWaitForHandles : System.Threading.WaitHandle[] * Microsoft.VisualStudio.Shell.Interop.IVsCommonMessagePumpClientEvents -> Microsoft.VisualStudio.Shell.CommonMessagePumpExitCode

Public Function ModalWaitForHandles (waitHandles As WaitHandle(), client As IVsCommonMessagePumpClientEvents) As CommonMessagePumpExitCode

Parameters

waitHandles

WaitHandle[]

The wait handles.

client

IVsCommonMessagePumpClientEvents

Caller implementation of IVsCommonMessagePumpClientEvents

Returns

CommonMessagePumpExitCode

ModalWaitForHandles(WaitHandle)

Blocks the current thread by pumping messages until either a timeout or the specified handle has been signaled.

public:
 Microsoft::VisualStudio::Shell::CommonMessagePumpExitCode ModalWaitForHandles(System::Threading::WaitHandle ^ waitHandle);

public Microsoft.VisualStudio.Shell.CommonMessagePumpExitCode ModalWaitForHandles (System.Threading.WaitHandle waitHandle);

member this.ModalWaitForHandles : System.Threading.WaitHandle -> Microsoft.VisualStudio.Shell.CommonMessagePumpExitCode

Public Function ModalWaitForHandles (waitHandle As WaitHandle) As CommonMessagePumpExitCode

Parameters

waitHandle

WaitHandle

The wait handle.

Returns

CommonMessagePumpExitCode

An exit code indicating why the wait ended.