nn::cec::CTR::MessageBox::CreateMessageBox Member Function

Syntax

nn::Result CreateMessageBox(
     const TitleId cecTitleId,
     const u32 privateId,
     const char * hmacKey,
     size_t inboxSizeMax = CEC_INBOX_SIZE_DEFAULT,
     size_t outboxSizeMax = CEC_OUTBOX_SIZE_DEFAULT,
     size_t inboxMessNumMax = CEC_INBOX_MESSNUM_DEFAULT,
     size_t outboxMessNumMax = CEC_OUTBOX_MESSNUM_DEFAULT,
     size_t messageSizeMax = CEC_MESSSIZEMAX_DEFAULT
);

Arguments

Name Description
in cecTitleId StreetPass ID
in privateId The key needed to open a message box.→ OpenMessageBox
The value used must be stored by the application accessing the message box.
in hmacKey Specifies the key needed to read a Message. Specify a string of 32 characters.This must be a key shared with the communication partner.
This value is used to check if the transmitted data has been tampered with. Transmitted data is signed with a signature generated using this key. Use a value stored by the application.
in inboxSizeMax Specifies the maximum amount of data that can be saved in the inbox. The combined size of the inbox and outbox must be no more than 1 MB. The default size is 512 * 1024 bytes.
in outboxSizeMax Specifies the maximum amount of data that can be saved in the outbox. The combined size of the inbox and outbox must be no more than 1 MB. The default size is 512 * 1024 bytes.
in inboxMessNumMax Specifies the maximum number of messages that can be saved in the inbox. The default is 99, which is the maximum specifiable value.
in outboxMessNumMax Specifies the maximum number of messages that can be saved in the outbox. The default is 99, which is the maximum specifiable value.
in messageSizeMax Specifies the maximum size of a message. Messages that exceed this size cannot be saved. Attempting to do so causes an error when calling WriteMessage.

Return Values

nn::Result

Value Description
ResultSuccess Process succeeded.
ResultBoxAlreadyExists The box already exists.
ResultBoxNumFull The maximum number of boxes have been created. To create a new box, you must delete a box for another game title.
ResultInvalidArgument An argument was specified incorrectly.
ResultInvalidData There is a problem with the data being set.
ResultStateBusy Unable to access because the daemon is busy.
A value other than the above. Failed.

Description

Creates a MessageBox. An inbox and outbox are created within the message box.

(In the final version, icons and application names must be set. This format is maintained for compatibility with previous versions.)

Revision History

2010/08/16
Initial version.

CONFIDENTIAL