1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../../css/manpage.css" type="text/css" />
7<title>WriteMessage</title>
8  </head>
9  <body>
10<h1><CODE>nn::cec::CTR::MessageBox::WriteMessage</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../../nn/Result/Overview.html">nn::Result</a> WriteMessage(
15     const <a href="../../../../nn/cec/CTR/Message/Overview.html">Message</a> & cecMessage,
16     const <a href="../../../../nn/cecd/CTR/CecBoxType.html">CecBoxType</a> boxType,
17     <a href="../../../../nn/cec/CTR/MessageId/Overview.html">MessageId</a> & messageIdOut
18);
19</pre>
20    </div>
21<h2>Arguments</h2>
22    <div class="section">
23      <table class="arguments">
24        <thead>
25          <tr>
26            <td width="15" />
27<th>Name</th>
28<td>Description</td>
29          </tr>
30        </thead>
31        <tr>
32<td>in</td>
33<th>cecMessage</th>
34<td>An object of the <a href="../../../../nn/cec/CTR/Message/Overview.html"><CODE>Message</CODE></a> class.</td>
35        </tr>
36        <tr>
37<td>in</td>
38<th>boxType</th>
39<td>Inbox/outbox specification.</td>
40        </tr>
41        <tr>
42<td>out</td>
43<th>messageIdOut</th>
44<td>Returns the <a href="../../../../nn/cec/CTR/MessageId/Overview.html"><CODE>MessageId</CODE></a> that is assigned during the write.</td>
45        </tr> </table>
46    </div>
47<h2>Return Values</h2>
48<div class="section"><a href="../../../../nn/Result/Overview.html"><CODE>nn::Result</CODE></a><br /> <br />
49      <table class="arguments">
50        <thead>
51          <tr>
52<th>Value</th>
53<td>Description</td>
54          </tr>
55        </thead>
56        <tr>
57<th><CODE>ResultSuccess</CODE></th>
58<td>Process succeeded.</td>
59        </tr>
60        <tr>
61<th><CODE>ResultNotAuthorized</CODE></th>
62<td>The box has not been opened.</td>
63        </tr>
64        <tr>
65<th><CODE>ResultMessTooLarge</CODE></th>
66<td>The message is too large.</td>
67        </tr>
68        <tr>
69<th><CODE>ResultBoxSizeFull</CODE></th>
70<td>The box's capacity has been exceeded.</td>
71        </tr>
72        <tr>
73<th><CODE>ResultBoxMessNumFull</CODE></th>
74<td>The maximum number of boxes has been exceeded.</td>
75        </tr>
76        <tr>
77<th><CODE>ResultNoData</CODE></th>
78<td>No message body or icon has been set for the message.</td>
79        </tr>
80        <tr>
81<th><CODE>ResultInvalidCombination</CODE></th>
82<td>The send count and propagation count have both been set equal to a value of 2 or greater.</td>
83        </tr>
84        <tr>
85<th><CODE>ResultNotAgreeEula</CODE></th>
86<td>The EULA has not been agreed to, or no icon file (ICN file) is configured in the ROM.</td>
87        </tr>
88        <tr>
89<th><CODE>ResultParentalControlCec</CODE></th>
90<td>Not allowed by Parental Controls.</td>
91        </tr>
92        <tr>
93<th><CODE>ResultStateBusy</CODE></th>
94<td>Unable to access because the daemon is busy (BUSY state).</td>
95        </tr>
96        <tr>
97<th>A value other than the above.</th>
98<td>Failed.</td>
99        </tr>
100      </table> </div>
101<h2>Description</h2>
102    <div class="section">
103<p>Writes a <a href="../../../../nn/cec/CTR/Message/Overview.html">message</a> to the system save region.</p><p>The message cannot be written if it is larger than 100 KB (including data such as the header and icon) or if it would exceed the box's maximum storage capacity or maximum number of messages. Because NAND memory (the save region) uses a block size of 4 KB, for some message sizes it may be impossible to write up to the maximum storage capacity. After writing, the written data is committed when the <CODE>CloseMessageBox</CODE> or <CODE>CommitMessageBox</CODE> function is called. <br /> When this function writes a message it checks the agreed EULA version. If no icon file (ICN file) is configured in the ROM, this function returns <a href="../../../../nn/cec/ResultNotAgreeEula/Overview.html"><CODE>ResultNotAgreeEula</CODE></a> in that situation also.<br />You must initialize the FS library before calling this function because the check uses <a href="../../../../nn/fs/Overview.html">FS</a> library features.</p></div>
104  <hr><p>CONFIDENTIAL</p></body>
105</html>