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>NWC24GetMsgIdList</TITLE>
7<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
8</HEAD>
9<BODY>
10<H1>NWC24GetMsgIdList</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> NWC24GetMsgIdList( <A HREF="../Types/NWC24MsgBoxId.html">NWC24MsgBoxId</A> <EM>mboxId</EM>, u32* <EM>idTable</EM>, u32 <EM>size</EM> );</CODE></PRE>
16</DL>
17
18<H2>Description</H2>
19<P>
20Returns a list of message IDs held in the specified message box (outbox or inbox).<BR>
21</P>
22
23<H2>Arguments</H2>
24<TABLE border="1" cellpadding="3" cellspacing="0.1">
25  <TR>
26<TD width="120" bgcolor="#ffffe8"><code><em><strong>mboxId</strong></em></code></TD>
27    <TD width="520">
28Message box type (<CODE>NWC24_SEND_BOX/NWC24_RECV_BOX</CODE>).
29    </TD>
30  </TR>
31  <TR>
32<TD width="120" bgcolor="#ffffe8"><code><em><strong>idTable</strong></em></code></TD>
33    <TD width="520">
34Pointer to the array where the message ID list is returned.<BR>
35    </TD>
36  </TR>
37  <TR>
38<TD width="120" bgcolor="#ffffe8"><code><em><strong>size</strong></em></code></TD>
39    <TD width="520">
40The number of elements in the array specified by <code><em><strong>idTable</strong></em></code>.<BR>
41    </TD>
42  </TR>
43</TABLE>
44
45<h2>Return Values</h2>
46<P>
47<code>NWC24_OK</code>: Normal exit. (The ID list is formed in the array indicated by *.)<code><em><strong>idTable</strong></em></code>).<BR> <code>NWC24_ERR_LIB_NOT_OPENED</code>: Library not open.<BR> <code>NWC24_ERR_INVALID_VALUE</code>: A value other than <code>NWC24_SEND_BOX</code> or <code>NWC24_RECV_BOX</code> was specified in <code><em><strong>mboxId</strong></em></code>.<BR> <code>NWC24_ERR_FULL</code>: The number of message IDs exceeds <code><em><strong>size</strong></em></code>. <BR> <code>NWC24_ERR_FILE_*</code>: Internal file operation related error.<BR><code>NWC24_ERR_VER_MISMATCH</code>: Message box version error.<BR>
48</P>
49
50<H2>See Also</H2>
51<P>
52</P>
53
54<H2>Revision History</H2>
55<P>
562007/05/03 Corrected the explanation of <B><CODE>size</CODE></B> to be 'the number of elements in the array' <BR>2006/10/06 Updated the list of return values.<BR>2006/08/01 Initial version.
57</P>
58
59<hr><p>CONFIDENTIAL</p></body>
60</HTML>