IOleComponent2::OnHandleSignaled Method (UInt32, IntPtr, Boolean)

 

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

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

int OnHandleSignaled(
	unsigned int nHandle,
	IntPtr pvLoopData,
	[OutAttribute] bool% pfContinue
)

Parameters

nHandle
Type: System::UInt32

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

pvLoopData
Type: System::IntPtr

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

pfContinue
Type: System::Boolean

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

Return Value

Type: System::Int32

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

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.

Return to top
Show: