IOleComponent2.OnTimeout Method

When overridden in a derived class, enables the component to respond to a time-out on the message loop.

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

Syntax

'Declaration
Function OnTimeout ( _
    pvLoopData As IntPtr, _
    <OutAttribute> ByRef pfContinue As Boolean _
) As Integer
int OnTimeout(
    IntPtr pvLoopData,
    out bool pfContinue
)
int OnTimeout(
    [InAttribute] IntPtr pvLoopData, 
    [OutAttribute] bool% pfContinue
)
abstract OnTimeout : 
        pvLoopData:IntPtr * 
        pfContinue:bool byref -> int
function OnTimeout(
    pvLoopData : IntPtr, 
    pfContinue : boolean
) : int

Parameters

  • pvLoopData
    Type: IntPtr

    The object that was passed in pvLoopData when FPushMessageLoop was called for this component.

  • pfContinue
    Type: Boolean%

    true to have this component re-enter the message loop; false to exit the message loop immediately.

Return Value

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

Remarks

If pfContinue is true, the component manager calls GetWaitHandlesAndTimeout to update the wait handles and time-out for this component, and then resumes the message loop.

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