nn::cec::CTR::MessageBox Class

class MessageBox

Class for accessing CEC MessageBox objects.

This allows you to create and delete boxes, read and write messages, get box information, and so forth. By creating a box with the CreateMessageBox function and then opening it with the OpenMessageBox function, you can access the messages in that box. You can use the WriteMessage function to write messages to a box. Messages written to the outbox are sent. Received messages are stored in the reception box and can be read with ReadMessage.
Call the CloseMessageBox function when you have finished accessing the box. When a message is created and written, a MessageId is given to the message. The MessageID is a randomly generated unique value, and each message is accessed using this value as the key.

Information, such as the attributes of individual messages, can be obtained with the GetMessageXXX functions.
Because the GetMessageXXX functions retrieve information from the message list stored in the system, they can acquire information faster than the message itself can be accessed with ReadMessage.
It is possible that the message list stored by the system and the information of the message itself may become unsynchronized due to an expected power outage, etc. (For example, you may be able to get the message ID but ReadMessage may fail.) The message list is regenerated when a message is written with WriteMessage, but if processing enters an irrecoverable state delete it using DeleteAllMessages and DeleteMessageBox.

The EULA version to which the user has agreed is checked when a message is written by the WriteMessage function. You must initialize the FS library in advance because FS library features are used to check this.

2010/08/16

Initial version.