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>NWC24ReadMsgToId</TITLE>
7<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
8</HEAD>
9<BODY>
10<H1>NWC24ReadMsgToId</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> NWC24ReadMsgToId( const <A HREF="../Types/NWC24MsgObj.html">NWC24MsgObj</A>* <EM>obj</EM>, u32 <EM>index</EM>, <A HREF="../Types/NWC24UserId.html">NWC24UserId</A>* <EM>userId</EM> );</CODE></PRE>
16</DL>
17
18<H2>Description</H2>
19<P>
20Reads one of the message recipient IDs from the message data.<BR>This is valid only for objects storing information for messages exchanged between Wii consoles.<BR>The actual message data must be opened and its text extracted because the recipient information is not included in the message object itself.<BR>
21</P>
22
23<H2>Arguments</H2>
24<TABLE border="1" cellpadding="3" cellspacing="0.1">
25  <TR>
26<TD width="120" bgcolor="#ffffe8"><code><em><strong>obj</strong></em></code></TD>
27    <TD width="520">
28Message object from which settings are to be extracted.
29    </TD>
30  </TR>
31  <TR>
32<TD width="120" bgcolor="#ffffe8"><code><em><strong>index</strong></em></code></TD>
33    <TD width="520">
34Index for selecting one among multiple recipients.<BR>
35    </TD>
36  </TR>
37  <TR>
38<TD width="120" bgcolor="#ffffe8"><code><em><strong>userId</strong></em></code></TD>
39    <TD width="520">
40Pointer to the location storing the extracted information (the recipient ID).<BR>
41    </TD>
42  </TR>
43</TABLE>
44
45<h2>Return Values</h2>
46<P>
47<code>NWC24_OK</code>: Normal exit (value returned in <code><em><strong>userId</strong></em></code>).<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 by <code><em><strong>obj</strong></em></code>.<BR> <code>NWC24_ERR_NOT_FOUND</code>: Specified <code><em><strong>index</strong></em></code> value is equal to or greater than the number of addresses 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_FORMAT</code>: Format error for the recipient address set for the message object.<BR> <code>NWC24_ERR_FILE_*</code>: Internal file operation error.<BR>
48</P>
49
50<H2>See Also</H2>
51<P>
52</P>
53
54<H2>Revision History</H2>
55<P>
562006/10/06 Updated return value list.<BR>2006/08/01 Initial version.
57</P>
58
59<hr><p>CONFIDENTIAL</p></body>
60</HTML>