IMsoComponent::FContinueMessageLoop Method

This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

Indicates whether the message loop pushed by the component should continue.

BOOL FContinueMessageLoop(
   ULONG uReason,
   void *pvLoopData,
   MSG *pMsgPeeked
);

Parameters

  • uReason [in]
    Specifies the reason the message loop is being pushed. For more information, see the Msoloop enumeration.

  • pvLoopData [in]
    The component's private data.

  • pMsgPeeked [in, optional]
    A pointer to the next message in the queue. This parameter is NULL if there are no more messages in the queue.

Return Value

TRUE to indicate that the message loop should continue; otherwise, FALSE.

Remarks

This method is called after peeking the next message in the queue (by calling the PeekMessage function) but before the message is removed from the queue. The peeked message is passed in the pMsgPeeked parameter. This method may be called again when the next message has already been removed from the queue, in which case the pMsgPeeked parameter is NULL.

If this method returns FALSE, the component manager terminates the loop without removing from the queue the message specified by the pMsgPeeked parameter.

See Also

Reference

IMsoComponent Interface

IMsoComponentManager::FPushMessageLoop Method