1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
3<HEAD>
4<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<META http-equiv="Content-Style-Type" content="text/css">
6<TITLE>NWC24DeleteMsg</TITLE>
7<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
8</HEAD>
9<BODY>
10<H1>NWC24DeleteMsg</H1>
11
12<H2>C Specification</H2>
13<DL>
14<DD><PRE><CODE>#include &lt;revolution/nwc24.h&gt;</CODE></PRE>
15<DD><PRE><CODE><A HREF="../Types/NWC24Err.html">NWC24Err</A> NWC24DeleteMsg( <A HREF="../Types/NWC24MsgBoxId.html">NWC24MsgBoxId</A> <EM>mboxId</EM>, u32 <EM>msgId</EM> );</CODE></PRE>
16</DL>
17
18<H2>Description</H2>
19<P>
20Deletes the message with the specified ID from the specified message box.
21</P>
22
23<P>
24A message can only be deleted by the same application that created that message.
25</P>
26
27<H2>Arguments</H2>
28<TABLE border="1" cellpadding="3" cellspacing="0.1">
29  <TR>
30<TD width="120" bgcolor="#ffffe8"><code><em><strong>mboxId</strong></em></code></TD>
31    <TD width="520">
32Message box type (NWC24_SEND_BOX/NWC24_RECV_BOX)
33    </TD>
34  </TR>
35  <TR>
36<TD width="120" bgcolor="#ffffe8"><code><em><strong>msgId</strong></em></code></TD>
37    <TD width="520">
38ID of the message to be deleted<BR>
39    </TD>
40  </TR>
41</TABLE>
42
43<h2>Return Values</h2>
44<P>
45<code>NWC24_OK</code>: Normal exit.<BR> <code>NWC24_ERR_LIB_NOT_OPENED</code>: The library is not open.<BR> <code>NWC24_ERR_INVALID_VALUE</code>: A value other than <code>NWC24_SEND_BOX</code> or <code>NWC24_RECV_BOX</code> has been specified for <code><em><strong>mboxId</strong></em></code> or the value of <code><em><strong>msgId</strong></em></code> is invalid.<BR> <code>NWC24_ERR_NOT_FOUND</code>: The message given by <code><em><strong>msgId</strong></em></code> does not exist in the message box.<BR> <code>NWC24_ERR_PROTECTED</code>: The application currently running cannot delete the specified message.<BR> <code>NWC24_ERR_FATAL</code>: A fatal error occurred upon deleting the message.<BR> <code>NWC24_ERR_FILE_*</code>: Error related to internal file operations.<BR> <code>NWC24_ERR_VER_MISMATCH</code>: Message box version error.<BR>
46</P>
47
48<H2>See Also</H2>
49<P>
50</P>
51
52<H2>Revision History</H2>
53<P>
542007/09/04 Deleted some portions of text in line with change to specification.<BR>2006/11/15 Added supplemental information and updated the list of return values.<BR>2006/08/01 Initial version.
55</P>
56
57<hr><p>CONFIDENTIAL</p></body>
58</HTML>