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>NWC24ReadMsgToAddr</TITLE>
7<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
8</HEAD>
9<BODY>
10<H1>NWC24ReadMsgToAddr</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> NWC24ReadMsgToAddr(
16    const <A HREF="../Types/NWC24MsgObj.html">NWC24MsgObj</A>* <EM>obj</EM>,
17    u32                <EM>index</EM>,
18    char*              <EM>buffer</EM>,
19    u32                <EM>bufSize</EM>
20);</CODE></PRE>
21</DL>
22
23<H2>Description</H2>
24<P>
25Reads one message recipient address from the message data.<BR>The actual message data must be opened and the recipient information string extracted, because it is not included in the message object itself.<BR><BR> This function is valid only for messages exchanged with standard e-mail addresses.<BR> <BR> The string to be retrieved is terminated with '\0' (NULL character).<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>obj</strong></em></code></TD>
32    <TD width="520">
33Message object from which settings are to be extracted.
34    </TD>
35  </TR>
36  <TR>
37<TD width="120" bgcolor="#ffffe8"><code><em><strong>index</strong></em></code></TD>
38    <TD width="520">
39Specifies one among multiple recipients.<BR>
40    </TD>
41  </TR>
42  <TR>
43<TD width="120" bgcolor="#ffffe8"><code><em><strong>buffer</strong></em></code></TD>
44    <TD width="520">
45Pointer to the region where the read string is stored.<BR>
46    </TD>
47  </TR>
48  <TR>
49<TD width="120" bgcolor="#ffffe8"><code><em><strong>bufSize</strong></em></code></TD>
50    <TD width="520">
51Size of the region specified by <code><em><strong>buffer</strong></em></code>.<BR>
52    </TD>
53  </TR>
54</TABLE>
55
56<h2>Return Values</h2>
57<P>
58<code>NWC24_OK</code>: Normal exit.<BR> <code>NWC24_ERR_LIB_NOT_OPENED</code>: Library not open.<BR> <code>NWC24_ERR_PROTECTED</code>: Message object cannot be read.<BR> <code>NWC24_ERR_NOT_SUPPORTED</code>: Unsupported message object specified for <code><em><strong>obj</strong></em></code>.<BR> <code>NWC24_ERR_NOT_FOUND</code>: The value specified for <code><em><strong>index</strong></em></code> is greater than or equal to the number of recipients set for the message object.<BR> <code>NWC24_ERR_NULL</code>: Message data not set.<BR> <code>NWC24_ERR_OVERFLOW</code>: Recipient addresses set for the message object overflowed the buffer.<BR> <code>NWC24_ERR_FILE_*</code>: Internal file operation error.<BR>
59</P>
60
61<H2>See Also</H2>
62<P>
63</P>
64
65<H2>Revision History</H2>
66<P>
672006/10/06 Updated return value list.<BR>2006/08/01 Initial version.
68</P>
69
70<hr><p>CONFIDENTIAL</p></body>
71</HTML>