Share via


IOleComponent2.GetWaitHandlesAndTimeout Method

When overridden in a derived class, returns the time-out and the list of handles on which this component is waiting.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.9.0 (in Microsoft.VisualStudio.Shell.Interop.9.0.dll)

Syntax

'Declaration
Function GetWaitHandlesAndTimeout ( _
    <OutAttribute> ByRef aHandles As IntPtr(), _
    <OutAttribute> ByRef pnHandles As UInteger, _
    <OutAttribute> ByRef pdwTimeout As UInteger, _
    pvLoopData As IntPtr _
) As Integer
int GetWaitHandlesAndTimeout(
    out IntPtr[] aHandles,
    out uint pnHandles,
    out uint pdwTimeout,
    IntPtr pvLoopData
)
int GetWaitHandlesAndTimeout(
    [InAttribute] [OutAttribute] array<IntPtr>^% aHandles, 
    [OutAttribute] unsigned int% pnHandles, 
    [OutAttribute] unsigned int% pdwTimeout, 
    [InAttribute] IntPtr pvLoopData
)
abstract GetWaitHandlesAndTimeout : 
        aHandles:IntPtr[] byref * 
        pnHandles:uint32 byref * 
        pdwTimeout:uint32 byref * 
        pvLoopData:IntPtr -> int
function GetWaitHandlesAndTimeout(
    aHandles : IntPtr[], 
    pnHandles : uint, 
    pdwTimeout : uint, 
    pvLoopData : IntPtr
) : int

Parameters

  • aHandles
    Type: array<System.IntPtr[]%

    When this method returns, contains an array of object handles for which this component is waiting, passed by reference. Must return at least one and no more than 64 handles. Must not return duplicate handles.

  • pnHandles
    Type: System.UInt32%

    When this method returns, contains the number of handles in aHandles.

  • pdwTimeout
    Type: System.UInt32%

    When this method returns, contains the time-out in milliseconds, or 0xFFFFFFFF for an infinite time-out.

Return Value

Type: System.Int32
An error code (HRESULT) value that indicates the status of the operation.

Remarks

When one of the handles is signaled, the IOleComponentManager calls OnHandleSignaled. If the time-out expires before a handle is signaled, IOleComponentManager calls OnTimeout.

This method is called on the same thread as the FPushMessageLoop method was called on when this component was added to the message loop.

.NET Framework Security

See Also

Reference

IOleComponent2 Interface

Microsoft.VisualStudio.Shell.Interop Namespace

IOleComponentManager