nn::cec::CTR::Message::NewMessage Member Function

Syntax

nn::Result NewMessage(
     TitleId cecTitleId,
     u32 groupId,
     MessageTypeFlag messageTypeFlag,
     SendMode sendMode,
     u8 sendCount,
     u8 propagationCount,
     void * icon,
     size_t iconSize,
     wchar_t * infoTextData,
     size_t infoTextSize
);

Arguments

Name Description
in cecTitleId StreetPass ID
in groupId Message group ID
Same as the value set with SetGroupID.
in messageTypeFlag Specifies whether the recipient is a friend or a non-friend using the MessageTypeFlag enumerated type.
in sendMode Specifies the send mode (receive only, send only, send and receive, or exchange) using the SendMode enumerated type. This is the same as the value set by the SetSendMode function.
in sendCount The sendCount and propagationCount values cannot both be set to greater than 1 at the same time.
in propagationCount The sendCount and propagationCount values cannot both be set to greater than 1 at the same time.
in icon Specifies an icon.
Format: RGB565 (little-endian)
Size: 40 x 40 (3200 bytes)
in iconSize Specifies the size of the icon data.
in infoTextData Sets the information text of a Message. Encoding UTF16-LE
Display size: The number of characters displayable as two lines of 16 double-byte characters
Maximum buffer size: 128 x 2 bytes (including line breaks and the NULL terminator)
in infoTextSize Specifies the data size for the information text of a Message.

Return Values

nn::Result

Value Description
ResultSuccess Process succeeded.
ResultInvalidArgument An invalid value has been set.
ResultInvalidCombination The transmission count and propagation count have both been set equal to a value of 2 or greater.
A value other than the above. Failed.

Description

Creates a new message.

This function sets the basic parameters. A message is sent via StreetPass after the SetMessageBody function has set the body (data) of the message and the MessageBox::WriteMessage function has written the message to the outbox.

Revision History

2010/08/16
Initial version.

CONFIDENTIAL