ControllerMessage::OverridesMessage

Defined in: C4Messages.h

Returns a boolean value indicating whether a message overrides a previous message in the journal.

Prototype

virtual bool OverridesMessage(const ControllerMessage *message) const;

Parameters

message A journaled message previously sent to the same controller as the destination for this message.

Description

The OverridesMessage function may be called one or more times when a journaled message is sent using the MessageMgr::SendMessageJournal function. Its purpose is to determine whether it overrides any journaled messages previously sent to the same controller. The OverridesMessage function is called on the new message object once for each previous message object in the journal for the same controller. It should inspect the message object pointed to by the message parameter and return true if it overrides it. Returning true will cause the previous message to be removed from the journal.