IVsCommonMessagePump.ModalWaitForObjectsWithClient Method

The method's behavior is very similar to ModalWaitForObjects. 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.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assemblies:   Microsoft.VisualStudio.Shell.Interop.10.0 (in Microsoft.VisualStudio.Shell.Interop.10.0.dll)
  Microsoft.VisualStudio.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)

Syntax

'Declaration
Function ModalWaitForObjectsWithClient ( _
    rgHandles As IntPtr(), _
    cHandles As UInteger, _
    pClient As IVsCommonMessagePumpClientEvents _
) As Integer
int ModalWaitForObjectsWithClient(
    IntPtr[] rgHandles,
    uint cHandles,
    IVsCommonMessagePumpClientEvents pClient
)
int ModalWaitForObjectsWithClient(
    [InAttribute] array<IntPtr>^ rgHandles, 
    [InAttribute] unsigned int cHandles, 
    [InAttribute] IVsCommonMessagePumpClientEvents^ pClient
)
abstract ModalWaitForObjectsWithClient : 
        rgHandles:IntPtr[] * 
        cHandles:uint32 * 
        pClient:IVsCommonMessagePumpClientEvents -> int
function ModalWaitForObjectsWithClient(
    rgHandles : IntPtr[], 
    cHandles : uint, 
    pClient : IVsCommonMessagePumpClientEvents
) : int

Parameters

  • rgHandles
    Type: array<IntPtr[]

    The array of handles for the objects to wait on.

  • cHandles
    Type: UInt32

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

Return Value

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

.NET Framework Security

See Also

Reference

IVsCommonMessagePump Interface

Microsoft.VisualStudio.Shell.Interop Namespace