IVsCommonMessagePumpClientEvents.OnHandleSignaled Method

The event is raised when a handle is signaled. Client implementations should decide if the wait can continue based on which handle(s) have been signaled so far.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assemblies:   Microsoft.VisualStudio.Shell.11.0 (in Microsoft.VisualStudio.Shell.11.0.dll)
  Microsoft.VisualStudio.Shell.Interop.10.0 (in Microsoft.VisualStudio.Shell.Interop.10.0.dll)

Syntax

'Declaration
Function OnHandleSignaled ( _
    nHandle As UInteger, _
    <OutAttribute> ByRef pfContinue As Boolean _
) As Integer

int OnHandleSignaled(
    uint nHandle,
    out bool pfContinue
)

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

abstract OnHandleSignaled : 
        nHandle:uint32 * 
        pfContinue:bool byref -> int

function OnHandleSignaled(
    nHandle : uint, 
    pfContinue : boolean
) : int

Parameters

• nHandle
  Type: System.UInt32

  The handle.

• pfContinue
  Type: System.Boolean%

  If false, tells the common message pump to quit and return S_OK.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

.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.

See Also

Reference

IVsCommonMessagePumpClientEvents Interface

Microsoft.VisualStudio.Shell.Interop Namespace