SimpleEditorView.FContinueMessageLoop Method

Article
02/04/2013

Called during each iteration of the message loop.

Namespace: Microsoft.VisualStudio.Package
Assemblies:   Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
  Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)

Syntax

'Declaration
Public Overridable Function FContinueMessageLoop ( _
    uReason As UInteger, _
    pvLoopData As IntPtr, _
    pMsgPeeked As MSG() _
) As Integer

public virtual int FContinueMessageLoop(
    uint uReason,
    IntPtr pvLoopData,
    MSG[] pMsgPeeked
)

public:
virtual int FContinueMessageLoop(
    unsigned int uReason, 
    IntPtr pvLoopData, 
    array<MSG>^ pMsgPeeked
)

abstract FContinueMessageLoop : 
        uReason:uint32 * 
        pvLoopData:IntPtr * 
        pMsgPeeked:MSG[] -> int 
override FContinueMessageLoop : 
        uReason:uint32 * 
        pvLoopData:IntPtr * 
        pMsgPeeked:MSG[] -> int

public function FContinueMessageLoop(
    uReason : uint, 
    pvLoopData : IntPtr, 
    pMsgPeeked : MSG[]
) : int

Parameters

uReason
Type: System.UInt32
An enumeration of type _OLELOOP.

pvLoopData
Type: System.IntPtr
A pointer to private data.

pMsgPeeked
Type: array<Microsoft.VisualStudio.OLE.Interop.MSG[]
An array of MSG structures. May be nulla null reference (Nothing in Visual Basic).

Return Value

Type: System.Int32
true if the message loop should continue, false otherwise.

Implements

IOleComponent.FContinueMessageLoop(UInt32, IntPtr, array<MSG[])

Remarks

By default this method is not implemented and simply returns true.

Notes to Implementers

uReason and pvLoopData are the reason and the \private data that were passed to FPushMessageLoop(). This method is called after peeking at the next message in the queue but before the message is removed from the queue. The peeked message is passed in the pMsgPeeked parameter (nulla null reference (Nothing in Visual Basic) if no message is in the queue). This method may also be called when the next message has already been removed from the queue, in which case pMsgPeeked is passed as nulla null reference (Nothing in Visual Basic). If this method returns false, the component manager terminates the loop without removing pMsgPeeked from the queue.

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

Share via