CommonMessagePump.IVsCommonMessagePump.ModalWaitForObjects Method

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

Namespace:  Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.11.0 (in Microsoft.VisualStudio.Shell.11.0.dll)

Syntax

'Declaration
Private Function ModalWaitForObjects ( _
    handles As IntPtr(), _
    handleCount As UInteger, _
    <OutAttribute> ByRef waitResult As UInteger _
) As Integer Implements IVsCommonMessagePump.ModalWaitForObjects

int IVsCommonMessagePump.ModalWaitForObjects(
    IntPtr[] handles,
    uint handleCount,
    out uint waitResult
)

private:
virtual int ModalWaitForObjects(
    array<IntPtr>^ handles, 
    unsigned int handleCount, 
    [OutAttribute] unsigned int% waitResult
) sealed = IVsCommonMessagePump::ModalWaitForObjects

private abstract ModalWaitForObjects : 
        handles:IntPtr[] * 
        handleCount:uint32 * 
        waitResult:uint32 byref -> int  
private override ModalWaitForObjects : 
        handles:IntPtr[] * 
        handleCount:uint32 * 
        waitResult:uint32 byref -> int

JScript does not support explicit interface implementations.

Parameters

• handles
  Type: array<System.IntPtr[]

  The array of handles to wait on.

• handleCount
  Type: System.UInt32

  The number of handles.

• waitResult
  Type: System.UInt32%

  [out] The index to the signaled handle, or WAIT_TIMEOUT if the wait timed out.

Return Value

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

Implements

IVsCommonMessagePump.ModalWaitForObjects(array<IntPtr[], UInt32, UInt32%)

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

CommonMessagePump Class

Microsoft.VisualStudio.Shell Namespace