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>DeleteMessage</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../../nn/Overview.html">nn</a>::<a href="../../../../nn/cec/Overview.html">cec</a>::<a href="../../../../nn/cec/CTR/Overview.html">CTR</a>::<a href="../../../../nn/cec/CTR/MessageBox/Overview.html">MessageBox</a>::DeleteMessage</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> DeleteMessage(
15     const <a href="../../../../nn/cec/CTR/CecBoxType.html">CecBoxType</a> boxType,
16     const <a href="../../../../nn/cec/CTR/MessageId/Overview.html">MessageId</a> & messageId,
17     bool withWriteBoxInfo
18);
19</pre>
20    </div>
21<h2>Parameters</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>boxType</th>
34<td>Inbox/outbox specification.</td>
35        </tr>
36        <tr>
37<td>in</td>
38<th>messageId</th>
39<td>Specifies a <a href="../../../../nn/cec/CTR/MessageId/Overview.html"><CODE>MessageId</CODE></a>.</td>
40        </tr>
41        <tr>
42<td>in</td>
43<th><CODE>withWriteBoxInfo</CODE></th>
44<td>Updates to the internal message list are skipped when <CODE>false</CODE> is specified. The list is updated when the <CODE><a href="../../../../nn/cec/CTR/MessageBox/CommitMessageBox.html">CommitMessageBox</a></CODE> or <CODE><a href="../../../../nn/cec/CTR/MessageBox/CloseMessageBox.html">CloseMessageBox</a></CODE> function is called.</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>Result::IsSuccess</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>A value other than the above.</th>
66<td>Process failed.</td>
67        </tr>
68      </table> </div>
69<h2>Description</h2>
70    <div class="section">
71<p>Deletes a <a href="../../../../nn/cec/CTR/Message/Overview.html">message</a>.</p><p>Written data is committed when the <CODE><a href="../../../../nn/cec/CTR/MessageBox/CloseMessageBox.html">CloseMessageBox</a></CODE> or <CODE><a href="../../../../nn/cec/CTR/MessageBox/CommitMessageBox.html">CommitMessageBox</a></CODE> function is called after a modification has been made. <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 delete multiple consecutive messages. Note that the <CODE>GetMessageBoxXXX</CODE> functions are unable to get accurate information if the list has not been updated.</p><!-- write here --></div>
72<h2>Revision History</h2>
73    <div class="section">
74      <dl class="history">
75        <dt>2010/08/16</dt>
76<dd>Initial version.<br />
77        </dd>
78      </dl>
79    </div>
80  <hr><p>CONFIDENTIAL</p></body>
81</html>
82