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>NWC24GetMsgAttachedPtr</TITLE>
7<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
8</HEAD>
9<BODY>
10<H1>NWC24GetMsgAttachedPtr</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> NWC24GetMsgAttachedPtr(
16    const <A HREF="../Types/NWC24MsgObj.html">NWC24MsgObj</A>* <EM>obj</EM>,
17    u32                <EM>index</EM>,
18    const char**       <EM>data</EM>
19);</CODE></PRE>
20</DL>
21
22<H2>Description</H2>
23<P>
24Returns a message object setting (a pointer to the attached binary source data). This function is only enabled when creating a message during the period after the message is committed by calling <CODE><A HREF="NWC24CommitMsg.html">NWC24CommitMsg()</A></CODE> and before it is stored in the outbox. (In other situations, it is necessary to use <CODE><A HREF="NWC24ReadMsgAttached.html">NWC24ReadMsgAttached()</A></CODE>, which references the message body.))
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">
32Message object from which settings are to be extracted.
33    </TD>
34  </TR>
35  <TR>
36<TD width="120" bgcolor="#ffffe8"><code><em><strong>index</strong></em></code></TD>
37    <TD width="520">
38Index for specifying one of multiple binary attachments.<BR>
39    </TD>
40  </TR>
41  <TR>
42<TD width="120" bgcolor="#ffffe8"><code><em><strong>data</strong></em></code></TD>
43    <TD width="520">
44Pointer to the location storing the extracted information, namely, the start address of the attached binary source data.<BR>
45    </TD>
46  </TR>
47</TABLE>
48
49<h2>Return Values</h2>
50<P>
51<code>NWC24_OK</code>: Normal exit (value returned in *<code><em><strong>data</strong></em></code>).<BR><code>NWC24_ERR_NULL</code>: The attached binary specified by <code><em><strong>index</strong></em></code> has not yet been set.<BR><code>NWC24_ERR_INVALID_VALUE</code>: The value of <code><em><strong>index</strong></em></code> is invalid.<BR><code>NWC24_ERR_PROTECTED</code>: Could not access the message object (for example, if it's already stored in the box).
52</P>
53
54<H2>See Also</H2>
55<P>
56</P>
57
58<H2>Revision History</H2>
59<P>
602007/01/16 Initial version.
61</P>
62
63<hr><p>CONFIDENTIAL</p></body>
64</HTML>