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>NWC24ReadMsgSubject</TITLE>
7<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
8</HEAD>
9<BODY>
10<H1>NWC24ReadMsgSubject</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> NWC24ReadMsgSubject(
16    const <A HREF="../Types/NWC24MsgObj.html">NWC24MsgObj</A>* <EM>obj</EM>,
17    char*              <EM>buffer</EM>,
18    u32                <EM>bufSize</EM>
19);</CODE></PRE>
20</DL>
21
22<H2>Description</H2>
23<P>
24Reads the subject of the message from the message data. The actual message data is opened and the string is extracted into memory.<BR> The string to be retrieved is terminated with '\0' (NULL character).<BR>
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>obj</strong></em></code></TD>
31    <TD width="520">
32The message object from which settings are to be extracted.
33    </TD>
34  </TR>
35  <TR>
36<TD width="120" bgcolor="#ffffe8"><code><em><strong>buffer</strong></em></code></TD>
37    <TD width="520">
38Pointer to the region where the read string is stored.<BR>
39    </TD>
40  </TR>
41  <TR>
42<TD width="120" bgcolor="#ffffe8"><code><em><strong>bufSize</strong></em></code></TD>
43    <TD width="520">
44The size of the region specified by <code><em><strong>buffer</strong></em></code>.<BR>
45    </TD>
46  </TR>
47</TABLE>
48
49<h2>Return Values</h2>
50<P>
51<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>: Subject title set for the message object overflowed the buffer.<BR> <code>NWC24_ERR_FILE_*</code>: Internal file operation error.<BR>
52</P>
53
54<H2>See Also</H2>
55<P>
56</P>
57
58<H2>Revision History</H2>
59<P>
602006/10/06 Updated return value list.<BR>2006/08/01 Initial version.
61</P>
62
63<hr><p>CONFIDENTIAL</p></body>
64</HTML>