nn::cec::CTR::MessageBox Class

Syntax

class MessageBox

Description

Class for accessing CEC MessageBox objects.

Member Functions

Create/Delete a Message Box
CreateMessageBox Creates a MessageBox. An inbox and outbox are created within the message box. Any message set in the outbox is automatically sent during StreetPass communication, and any received data is stored in the inbox.
DeleteMessageBox Deletes a MessageBox.
OpenMessageBox Opens a MessageBox. You must use this function to open a box before you can access the messages within it.
Message Operations
ReadMessage Reads a Message.
WriteMessage Writes a Message to the system save region.
DeleteMessage Deletes a Message.
Controlling Boxes and Getting Information
GetMessageBoxData Gets the data associated with a MessageBox.
GetMessageBoxDataSize Gets the data size associated with a MessageBox.
SetMessageBoxData Sets the data associated with a MessageBox.
SetMessageBoxName Sets a MessageBox's name.
SetMessageBoxIcon Sets a MessageBox's icon.
GetMessageBoxName Gets a MessageBox's name.
GetMessageBoxIcon Gets a MessageBox's icon.
Getting Message Box Information
GetBoxFlag Gets the attributes of a MessageBox.
GetBoxSizeMax Gets the capacity of the inbox or outbox.
GetBoxSize Gets the current size of the inbox or outbox.
GetBoxMessNumMax Gets the maximum number of Messages in the inbox or outbox.
GetBoxMessNum Gets the number of Messages in the inbox or outbox.
GetBoxGroupNumMax Gets the maximum number of Message groups in the inbox or outbox.
GetBoxGroupNum Gets the number of Message groups in the inbox or outbox.
SetBoxGroupNumMax Sets the maximum number of Message groups in the inbox or outbox.
GetBoxSessionNum Gets the Session ID count for (the number of items received in) the inbox.
Getting Message Information (old API)
GetInBoxMessIdByIndex Gets the MessageID of the nth Message in the inbox.
GetOutBoxMessIdByIndex Gets the MessageID of the nth Message in the outbox.
GetMessSizeByMessId Gets the size of the Message with the specified MessageID.
Getting Message Information
GetMessageMessSize Gets the size of a message.
GetMessageBodySize Gets the size of a message's body.
GetMessageGroupId Gets the group ID of a message.
GetMessageSessionId Gets an inbox message's Session ID. (The ID assigned when received.)
GetMessageMessTypeFlag Gets the CecMessageTypeFlag of a message.
GetMessageSendMode Gets the SendMode of a message.
GetMessageSendCount Gets the send count of a message.
GetMessagePropagationCount Gets the propagation count of a message.
GetMessageTag Gets the message tag of a message.
GetMessageSendDate Gets the timestamp of when a received message was sent.
GetMessageRecvDate Gets the timestamp of when a message was received.
GetMessageCreateDate Gets the timestamp of when a message was created.
GetMessageMessIdPair Gets the pair of MessageIDs corresponding to a message exchange.
GetMessageMessId Gets the MessageID of a message.
GetMessIndex Gets a message's index (messIndex) based on its MessageID.
Other
SetBoxActivate Specifies whether a MessageBox is enabled or disabled. A disabled box will not have any data sent or received.
GetBoxActivate Gets whether a MessageBox is enabled or disabled. A disabled box will not have any data sent or received.
RoundOutBoxIndex Moves the Message with the specified MessageID to the end of the outbox's outgoing message queue.( The queue order is automatically changed when a message is sent, so there is normally no need to call this function.)

Revision History

2010/08/16
Initial version.

CONFIDENTIAL