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"><CODE>nn::Result</CODE></a> WriteMessage(
15     const <a href="../../../../nn/cec/CTR/Message/Overview.html">Message</a> & cecMessage,
16     const <a href="../../../../nn/cecd/CTR/CecBoxType.html"><CODE>CecBoxType</CODE></a> boxType,
17     <a href="../../../../nn/cec/CTR/MessageId/Overview.html">MessageId</a> & messageIdOut,
18     bool withWriteBoxInfo
19);
20</pre>
21    </div>
22    <h2>Arguments</h2>
23    <div class="section">
24      <table class="arguments">
25        <thead>
26          <tr>
27            <td width="15" />
28            <th>Name</th>
29            <td>Description</td>
30          </tr>
31        </thead>
32        <tr>
33          <td>in</td>
34          <th>cecMessage</th>
35          <td>An object of the <a href="../../../../nn/cec/CTR/Message/Overview.html"><CODE>Message</CODE></a> class.</td>
36        </tr>
37        <tr>
38          <td>in</td>
39          <th>boxType</th>
40          <td>Inbox/outbox specification.</td>
41        </tr>
42        <tr>
43          <td>out</td>
44          <th>messageIdOut</th>
45          <td>Returns the <a href="../../../../nn/cec/CTR/MessageId/Overview.html"><CODE>MessageID</CODE></a> that is assigned during the write.</td>
46        </tr>
47        <tr>
48          <td>in</td>
49          <th><CODE>withWriteBoxInfo</CODE></th>
50          <td>Updates to the internal message list are skipped when <CODE>false</CODE> is specified. The list is updated when the <CODE>CommitMessageBox</CODE> or <CODE>CloseMessageBox</CODE> function is called.</td>
51        </tr> </table>
52    </div>
53    <h2>Return Values</h2>
54    <div class="section"><a href="../../../../nn/Result/Overview.html">nn::Result</a><br /> <br />
55      <table class="arguments">
56        <thead>
57          <tr>
58            <th>Value</th>
59            <td>Description</td>
60          </tr>
61        </thead>
62        <tr>
63          <th><CODE>ResultSuccess</CODE></th>
64          <td>Process succeeded.</td>
65        </tr>
66        <tr>
67          <th>ResultNotAuthorized</th>
68          <td>The box has not been opened.</td>
69        </tr>
70        <tr>
71          <th><CODE>ResultMessTooLarge</CODE></th>
72          <td>The message is too large.</td>
73        </tr>
74        <tr>
75          <th><CODE>ResultBoxSizeFull</CODE></th>
76          <td>The box's capacity has been exceeded.</td>
77        </tr>
78        <tr>
79          <th><CODE>ResultBoxMessNumFull</CODE></th>
80          <td>The maximum number of boxes has been exceeded.</td>
81        </tr>
82        <tr>
83          <th><CODE>ResultInvalidCombination</CODE></th>
84          <td>The transmission count and propagation count have both been set equal to a value of 2 or greater.</td>
85        </tr>
86        <tr>
87          <th><CODE>ResultNotAgreeEula</CODE></th>
88          <td>The user has not agreed to the EULA or the icon file was not configured. </td>
89        </tr>
90        <tr>
91          <th><CODE>ResultParentalControlCec</CODE></th>
92          <td>Not allowed by Parental Controls.</td>
93        </tr>
94        <tr>
95          <th><CODE>ResultStateBusy</CODE></th>
96          <td>Unable to access because the daemon is busy.</td>
97        </tr>
98        <tr>
99          <th>A value other than the above.</th>
100          <td>Failed.</td>
101        </tr>
102      </table> </div>
103    <h2>Description</h2>
104    <div class="section">
105      <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 its size is larger than 100 KB or if writing it would exceed the box's maximum storage capacity or maximum number of messages. After writing, the written data is committed after <CODE>CloseMessageBox</CODE> or <CODE>CommitMessageBox</CODE> are called. <br /><br />If you set <SPAN class="argument">withWriteBoxInfo</SPAN> equal to <CODE>false</CODE>, updates to the internal message list are skipped. This allows you to shorten the amount of time taken to write multiple consecutive messages. Note that the <CODE>GetMessageBoxXXX</CODE> functions are unable to get accurate information if the list has not been updated. <br /> When the function writes the message, it checks the EULA agreement version, and if the icon file is not configured, the function returns <a href="../../../../nn/cec/ResultNotAgreeEula/Overview.html">ResultNotAgreeEula</a>. <br /> You must initialize the FS library before calling this function because this function uses the <a href="../../../../nn/fs/Overview.html">FS</a> library to check the EULA.</p></div>
106  <hr><p>CONFIDENTIAL</p></body>
107</html>