SimpleEditorView.FContinueMessageLoop(UInt32, IntPtr, MSG[]) Method

Definition

Namespace:

Microsoft.VisualStudio.Package

Assembly:

Microsoft.VisualStudio.Package.LanguageService.15.0.dll

Package:

Microsoft.VisualStudio.Package.LanguageService.15.0 v17.12.40392

Called during each iteration of the message loop.

public:
 virtual int FContinueMessageLoop(System::UInt32 uReason, IntPtr pvLoopData, cli::array <Microsoft::VisualStudio::OLE::Interop::MSG> ^ pMsgPeeked);

public virtual int FContinueMessageLoop (uint uReason, IntPtr pvLoopData, Microsoft.VisualStudio.OLE.Interop.MSG[] pMsgPeeked);

abstract member FContinueMessageLoop : uint32 * nativeint * Microsoft.VisualStudio.OLE.Interop.MSG[] -> int
override this.FContinueMessageLoop : uint32 * nativeint * Microsoft.VisualStudio.OLE.Interop.MSG[] -> int

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

Parameters

uReason

UInt32

An enumeration of type _OLELOOP.

pvLoopData

IntPtr

nativeint

A pointer to private data.

pMsgPeeked

MSG[]

An array of MSG structures. May be null.

Returns

Int32

true if the message loop should continue, false otherwise.

Implements

FContinueMessageLoop(UInt32, IntPtr, MSG[])

Remarks

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

Notes to Inheritors

uReason and pvLoopData are the reason and the \private data that were passed to Microsoft.VisualStudio.OLE.Interop.IOleComponentManager.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 (null 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 null. If this method returns false, the component manager terminates the loop without removing pMsgPeeked from the queue.