IOleComponent2.OnTimeout(IntPtr, Boolean) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.9.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 int OnTimeout(IntPtr pvLoopData, [Runtime::InteropServices::Out] bool % pfContinue);

public int OnTimeout (IntPtr pvLoopData, out bool pfContinue);

abstract member OnTimeout : nativeint * bool -> int

Public Function OnTimeout (pvLoopData As IntPtr, ByRef pfContinue As Boolean) As Integer

Parameters

pvLoopData: IntPtr
nativeint

The object that was passed in pvLoopData when FPushMessageLoop(UInt32, UInt32, IntPtr) was called for this component.

pfContinue: Boolean

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

Returns

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.

Applies to

Share via