CMessage Class¶

Overview¶

Note

The CMessage class handles messages used in a messaging queue

The structure used for this class is CMessage

Quick Ref

virtual short CMessage::GetCommType()

virtual unsigned char CMessage::GetMsgSubType()

virtual unsigned char CMessage::GetMsgType()

virtual void CMessage::MarshalMessage(unsigned char** pData, unsigned long* dwSize)

virtual void CMessage::Run()

virtual int CMessage::UnmarshalMessage(unsigned char* pData, unsigned long dwSize)

Name	Description
CMessage::GetCommType	Returns the message communication type
CMessage::GetMsgSubType	Returns the message sub-type
CMessage::GetMsgType	Returns the message type
CMessage::MarshalMessage	Marshal the `CMessage` object
CMessage::Run	Execution of the message
CMessage::UnmarshalMessage	Unmarshal the `CMessage` object

Returns the message communication type

virtual short CMessage::GetCommType();

Return Value

Returns short

Remarks

Returns the message sub-type

virtual unsigned char CMessage::GetMsgSubType();

Return Value

Returns unsigned char

Remarks

Returns the message type

virtual unsigned char CMessage::GetMsgType();

Return Value

Returns unsigned char

Remarks

Transforming the memory representation of the CMessage object to a data format suitable for storage or transmission

virtual void CMessage::MarshalMessage(
   unsigned char** pData,
   unsigned long* dwSize);

Parameters

unsigned char** pData - pointer to a pointer to data
unsigned long* dwSize - pointer to a dword variable that contains the size of data pointed to by pData

Remarks

Execution of the message

virtual void CMessage::Run();

Remarks

Transforming a representation of the CMessage object that was used for storage or transmission to a representation of the object that is executable

virtual int CMessage::UnmarshalMessage(
   unsigned char\* pData,
   unsigned long dwSize);

Parameters

Return Value

Returns int

Remarks