CMessageHandler Class¶

Overview
Quick Reference
Constructors
Methods

Overview¶

Note

The CMessageHandler class handles the management of messages in the message queue

The structure used for this class is CMessageHandler

Quick Reference¶

Quick Ref

void CMessageHandler::CMessageHandler()

void CMessageHandler::~CMessageHandler()

short CMessageHandler::AddMessage(CMessage* message, int bForcePassThrough)

void CMessageHandler::AsynchronousUpdate()

short CMessageHandler::Broadcast(CMessage* message, unsigned char bSendMessageToSelf, unsigned char bIgnoreObjectControl)

void CMessageHandler::ClearMessages()

int CMessageHandler::ImportantMessage(unsigned char* pData, unsigned long dwSize)

void CMessageHandler::PostAsynchronousUpdate()

short CMessageHandler::Send(CMessage* message)

Constructors¶

Name	Description
CMessageHandler::CMessageHandler	Constructs a `CMessageHandler` object
CMessageHandler::CMessageHandler	Destroys a `CMessageHandler` object

CMessageHandler::CMessageHandler¶

Constructs a CMessageHandler object

void CMessageHandler::CMessageHandler();

Remarks

Constructs a CMessageHandler object

CMessageHandler::~CMessageHandler¶

Destroys the CMessageHandler object

virtual void CMessageHandler::~CMessageHandler();

Remarks

Destroys the CMessageHandler object

Methods¶

Name	Description
CMessageHandler::AddMessage
CMessageHandler::AsynchronousUpdate
CMessageHandler::Broadcast
CMessageHandler::ClearMessages
CMessageHandler::ImportantMessage
CMessageHandler::PostAsynchronousUpdate
CMessageHandler::Send

CMessageHandler::AddMessage¶

short CMessageHandler::AddMessage(
   CMessage* message,
   int bForcePassThrough);

Parameters

CMessage* message -
int bForcePassThrough -

Return Value

Returns short

Remarks

CMessageHandler::AsynchronousUpdate¶

void CMessageHandler::AsynchronousUpdate();

Remarks

CMessageHandler::Broadcast¶

short CMessageHandler::Broadcast(
   CMessage* message,
   unsigned char bSendMessageToSelf,
   unsigned char bIgnoreObjectControl);

Parameters

CMessage* message -
unsigned char bSendMessageToSelf -
unsigned char bIgnoreObjectControl -

Return Value

Returns short

Remarks

CMessageHandler::ClearMessages¶

void CMessageHandler::ClearMessages();

Remarks

CMessageHandler::ImportantMessage¶

int CMessageHandler::ImportantMessage(
   unsigned char* pData,
   unsigned long dwSize);

Parameters

unsigned char* pData - pointer to message data
unsigned long dwSize - size of message data pointed to by pData

Return Value

Returns int

Remarks

CMessageHandler::PostAsynchronousUpdate¶

void CMessageHandler::PostAsynchronousUpdate();

Remarks

CMessageHandler::Send¶

short CMessageHandler::Send(CMessage* message);

Parameters

CMessage* message -

Return Value

Returns short

Remarks