IOleComponent2.OnHandleSignaled Method
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)
Syntax
'Declaration
Function OnHandleSignaled ( _
nHandle As UInteger, _
pvLoopData As IntPtr, _
<OutAttribute> ByRef pfContinue As Boolean _
) As Integer
int OnHandleSignaled(
uint nHandle,
IntPtr pvLoopData,
out bool pfContinue
)
int OnHandleSignaled(
[InAttribute] unsigned int nHandle,
[InAttribute] IntPtr pvLoopData,
[OutAttribute] bool% pfContinue
)
abstract OnHandleSignaled :
nHandle:uint32 *
pvLoopData:IntPtr *
pfContinue:bool byref -> int
function OnHandleSignaled(
nHandle : uint,
pvLoopData : IntPtr,
pfContinue : boolean
) : int
Parameters
nHandle
Type: UInt32The zero-based index of the handle that was signaled.
pvLoopData
Type: IntPtrThe object that was passed in pvLoopData when FPushMessageLoop was called for this component.
pfContinue
Type: 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: 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.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.