IOleComponent2.OnHandleSignaled(UInt32, IntPtr, Boolean) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

When overridden in a derived class, enables the component to respond to a signal on a wait handle.

public:
 int OnHandleSignaled(System::UInt32 nHandle, IntPtr pvLoopData, [Runtime::InteropServices::Out] bool % pfContinue);

public int OnHandleSignaled (uint nHandle, IntPtr pvLoopData, out bool pfContinue);

abstract member OnHandleSignaled : uint32 * nativeint * bool -> int

Public Function OnHandleSignaled (nHandle As UInteger, pvLoopData As IntPtr, ByRef pfContinue As Boolean) As Integer

Parameters

nHandle

UInt32

The zero-based index of the handle that was signaled.

pvLoopData

IntPtr

nativeint

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

pfContinue

Boolean

When this method returns, contains true to have this component re-enter the message loop, or false to exit the message loop immediately.

Returns

Int32

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

Remarks

nHandle contains the index of the wait handle in the array that was returned when the component manager called GetWaitHandlesAndTimeout.

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.