nn::cec::CTR::Message Class

Syntax

class Message

Description

Class that handles CEC Message objects.

Member Functions

New Message Creation
NewMessage Creates a new message.
Parameters
GetCecTitleId Gets the StreetPass ID of the Message.
SetGroupID Sets the Group ID for a Message. Messages in the outbox with the same GroupID are grouped and sent together.
GetGroupID Gets the Group ID of a message. Messages in the outbox with the same GroupID are grouped and sent together.
GetMessSize Gets the size of a message.
GetHeaderSize Gets the size of a message header (including the extended header).
GetBodySize Gets the size of the body of a Message.
GetMessageId Gets the MessageID for a Message. The MessageID is assigned when a message is created and then saved.
GetMessageId_Pair Gets the MessageID for the exchanged Message. With this method of message exchange, each partner records the MessageID of the message they sent in the message they received.
SetMessageTypeFlag Specifies the recipients using the MessageTypeFlag enumerated type.
GetMessageTypeFlag Gets the value specified for the message to be sent.
SetSendMode Specifies the send mode (receive only, send only, send and receive, or exchange) using the SendMode enumerated type.
GetSendMode Gets the send mode (receive only, send only, send and receive, or exchange).
GetSendDate Gets the timestamp of when a message was sent. This is the time according to the sender's clock.
GetRecvDate Gets the timestamp of when a message was received. This is the time according to the recipient's clock.
GetCreateDate Gets the creation timestamp of a message.
SetSendCount Specifies the send count. The send count is decremented by one with each send. The data is no longer sent once the count reaches zero.
GetSendCount Gets the send count. The send count is decremented by one with each send. The data is no longer sent once the count reaches zero.
SetPropagationCount Specifies the propagation count. The propagation count is decremented by one upon reception. The data is copied to the outbox if the count is one or greater.
GetPropagationCount Gets the propagation count. The propagation count is decremented by one upon reception. The data is copied to the outbox if the count is one or greater.
SetTag Sets the 16-bit value in the header of the Message.
GetTag Gets the Tag value from the header of a message.
SetExHeader Sets the extended header data for a message.
GetExHeader Gets data from the extended header of a message.
SetIcon Sets an icon to a Message.
GetIcon Gets an icon from a Message.
SetInfoText Sets the description of a Message.
GetInfoText Gets the description of a Message.
SetMessageBody Sets the data body of a message.
GetMessageBody Gets the body data of a Message.
GetMessageBodyPointer Gets a pointer to the body data of a Message.
Other
Message Constructor.

Revision History

2010/08/16
Initial version.

CONFIDENTIAL