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>NWC24SearchMsgs</TITLE>
7<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
8</HEAD>
9<BODY>
10<H1>NWC24SearchMsgs</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> NWC24SearchMsgs(
16    <A HREF="../Types/NWC24MsgObj.html">NWC24MsgObj</A>* <EM>msgObjArray</EM>,
17    u32          <EM>arraySize</EM>,
18    u32*         <EM>numStored</EM>,
19    u32*         <EM>numRemain</EM>
20);</CODE></PRE>
21</DL>
22
23<H2>Description</H2>
24<P>
25Performs a message search and stores the obtained results in an array in <A HREF="../Types/NWC24MsgObj.html">NWC24MsgObj</A> format.<BR>When the results are more numerous than the array size specified in <code><em><strong>arraySize</strong></em></code>, the number of remaining elements is returned in <code><em><strong>numRemain</strong></em></code>; those are stored the next time this function is called. All of the search results can be gotten by repeatedly calling this function (without initializing in between calls) until <code><em><strong>numRemain</strong></em></code> is 0.<BR>
26</P>
27
28<H2>Arguments</H2>
29<TABLE border="1" cellpadding="3" cellspacing="0.1">
30  <TR>
31<TD width="120" bgcolor="#ffffe8"><code><em><strong>msgObjArray</strong></em></code></TD>
32    <TD width="520">
33A pointer to the start of the <A HREF="../Types/NWC24MsgObj.html">NWC24MsgObj</A> array that stores the search results.
34    </TD>
35  </TR>
36  <TR>
37<TD width="120" bgcolor="#ffffe8"><code><em><strong>arraySize</strong></em></code></TD>
38    <TD width="520">
39The number of elements in the array specified by <code><em><strong>msgObjArray</strong></em></code>.
40    </TD>
41  </TR>
42  <TR>
43<TD width="120" bgcolor="#ffffe8"><code><em><strong>numStored</strong></em></code></TD>
44    <TD width="520">
45A pointer to a u32 variable that returns the number of stored results.
46    </TD>
47  </TR>
48  <TR>
49<TD width="120" bgcolor="#ffffe8"><code><em><strong>numRemain</strong></em></code></TD>
50    <TD width="520">
51A pointer to a u32 variable that returns the remaining number of results.
52    </TD>
53  </TR>
54</TABLE>
55
56<h2>Return Values</h2>
57<P>
58<code>NWC24_OK</code>: Normal exit (search results are stored in an array, values are returned in <code><em><strong>numStored</strong></em></code> and <code><em><strong>numRemain</strong></em></code>).<BR> <code>NWC24_ERR_LIB_NOT_OPENED</code>: Library not open.<BR> <code>NWC24_ERR_NULL</code>: The <code><em><strong>msgObjArray</strong></em></code> value is a null pointer, even though <code><em><strong>arraySize</strong></em></code> is not zero.<BR> <code>NWC24_ERR_FILE_*</code>: File access error.<BR>
59</P>
60
61<H2>See Also</H2>
62<P>
63<A href="NWC24InitSearchConds.html"><CODE>NWC24InitSearchConds</CODE></A>, <A href="NWC24SetSearchCondMsgBox.html"><CODE>NWC24SetSearchCondMsgBox</CODE></A>, <A href="NWC24SetSearchCondForMenu.html"><CODE>NWC24SetSearchCondForMenu</CODE></A>, <A href="NWC24SetSearchCondPublic.html"><CODE>NWC24SetSearchCondPublic</CODE></A>, <A href="NWC24SetSearchCondFromAddrId.html"><CODE>NWC24SetSearchCondFromAddrId</CODE></A>, <A href="NWC24SetSearchCondAppId.html"><CODE>NWC24SetSearchCondAppId</CODE></A>
64</P>
65
66<H2>Revision History</H2>
67<P>
682007/09/03 Added <CODE>NWC24SetSearchCondPublic</CODE> to the See Also section.<BR>2006/09/01 Initial version.
69</P>
70
71<hr><p>CONFIDENTIAL</p></body>
72</HTML>