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>NWC24ReadMsgText</TITLE>
7<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
8</HEAD>
9<BODY>
10<H1>NWC24ReadMsgText</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> NWC24ReadMsgText(
16    const <A HREF="../Types/NWC24MsgObj.html">NWC24MsgObj</A>* <EM>obj</EM>,
17    char*              <EM>buffer</EM>,
18    u32                <EM>bufSize</EM>,
19    <A HREF="../Types/NWC24Charset.html">NWC24Charset</A>*      <EM>charset</EM>,
20    <A HREF="../Types/NWC24Encoding.html">NWC24Encoding</A>*     <EM>encoding</EM>
21);</CODE></PRE>
22</DL>
23
24<H2>Description</H2>
25<P>
26Reads the string data that represents body text of the message from message data. The actual message data is opened and the string is extracted into memory. The character code (<CODE>Charset</CODE>) and MIME encoding information set by the sender are also retrieved at the same time. The string to be retrieved is terminated with '\0' (NULL character).<BR>
27</P>
28
29<H2>Arguments</H2>
30<TABLE border="1" cellpadding="3" cellspacing="0.1">
31  <TR>
32<TD width="120" bgcolor="#ffffe8"><code><em><strong>obj</strong></em></code></TD>
33    <TD width="520">
34Message object from which settings are to be extracted.
35    </TD>
36  </TR>
37  <TR>
38<TD width="120" bgcolor="#ffffe8"><code><em><strong>buffer</strong></em></code></TD>
39    <TD width="520">
40Pointer to the region where the read string is to be stored.<BR>
41    </TD>
42  </TR>
43  <TR>
44<TD width="120" bgcolor="#ffffe8"><code><em><strong>bufSize</strong></em></code></TD>
45    <TD width="520">
46Size of the region specified by <code><em><strong>buffer</strong></em></code>.<BR>
47    </TD>
48  </TR>
49  <TR>
50<TD width="120" bgcolor="#ffffe8"><code><em><strong>charset</strong></em></code></TD>
51    <TD width="520">
52Pointer storing the type of character code that was read.<BR>
53    </TD>
54  </TR>
55  <TR>
56<TD width="120" bgcolor="#ffffe8"><code><em><strong>encoding</strong></em></code></TD>
57    <TD width="520">
58Pointer storing the type of MIME encoding that was read.<BR>
59    </TD>
60  </TR>
61</TABLE>
62
63<h2>Return Values</h2>
64<P>
65<code>NWC24_OK</code>: Normal exit.<BR> <code>NWC24_ERR_LIB_NOT_OPENED</code>: Library is not open.<BR> <code>NWC24_ERR_PROTECTED</code>: Cannot read message object.<BR> <code>NWC24_ERR_NULL</code>: Message data not set.<BR> <code>NWC24_ERR_OVERFLOW</code>: Message body set for message object overflowed buffer.<BR> <code>NWC24_ERR_NOT_SUPPORTED</code>: Unsupported character code or MIME encoding type set for message object.<BR> <code>NWC24_ERR_FILE_*</code>: Internal file operation error.<BR>
66</P>
67
68<H2>See Also</H2>
69<P>
70</P>
71
72<H2>Revision History</H2>
73<P>
742006/10/06 Updated return value list.<BR>2006/08/01 Initial version.
75</P>
76
77<hr><p>CONFIDENTIAL</p></body>
78</HTML>