IVsCommonMessagePump.ModalWaitForObjectsWithClient Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Shell.Interop
Assemblies:
Microsoft.VisualStudio.Shell.14.0.dll, Microsoft.VisualStudio.Shell.Interop.10.0.dll
Assemblies:
Microsoft.VisualStudio.Shell.15.0.dll, Microsoft.VisualStudio.Shell.Interop.10.0.dll
Assembly:
Microsoft.VisualStudio.Shell.Interop.10.0.dll
Assembly:
Microsoft.VisualStudio.Interop.dll
Package:
Microsoft.VisualStudio.Interop v17.9.37000

The method's behavior is very similar to ModalWaitForObjects(IntPtr[], UInt32, UInt32). In addition, it allows for a custom wait and events processing logic to be supplied. The method makes VS modal, and automatically provides the default wait UI after about 2 seconds of waiting.

public:
 int ModalWaitForObjectsWithClient(cli::array <IntPtr> ^ rgHandles, System::UInt32 cHandles, Microsoft::VisualStudio::Shell::Interop::IVsCommonMessagePumpClientEvents ^ pClient);
public int ModalWaitForObjectsWithClient (IntPtr[] rgHandles, uint cHandles, Microsoft.VisualStudio.Shell.Interop.IVsCommonMessagePumpClientEvents pClient);
abstract member ModalWaitForObjectsWithClient : nativeint[] * uint32 * Microsoft.VisualStudio.Shell.Interop.IVsCommonMessagePumpClientEvents -> int
Public Function ModalWaitForObjectsWithClient (rgHandles As IntPtr(), cHandles As UInteger, pClient As IVsCommonMessagePumpClientEvents) As Integer

Parameters

rgHandles

IntPtr[]

nativeint[]

The array of handles for the objects to wait on.

cHandles
UInt32

The number of handles in the array. The maximum is 64.

pClient
IVsCommonMessagePumpClientEvents

The IVsCommonMessagePumpClientEvents.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Applies to