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>NWC24GetMsgObj</TITLE>
7<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
8</HEAD>
9<BODY>
10<H1>NWC24GetMsgObj</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> NWC24GetMsgObj( <A HREF="../Types/NWC24MsgObj.html">NWC24MsgObj</A>* <EM>obj</EM>, <A HREF="../Types/NWC24MsgBoxId.html">NWC24MsgBoxId</A> <EM>mboxId</EM>, u32 <EM>msgId</EM> );</CODE></PRE>
16</DL>
17
18<H2>Description</H2>
19<P>
20Gets the meta-information about the message with the specified ID in the specified message box and expands that information into an <A HREF="../Types/NWC24MsgObj.html">NWC24MsgObj object</A>.<BR>
21</P>
22
23<P>
24<CODE>NWC24_ERR_HIDDEN</CODE> is returned without expanding data for messages that cannot be opened from the application currently running. (This occurs, for example, in the case of messages that have been created by another application with <CODE>NWC24_MSGTYPE_WII_APP_HIDDEN</CODE> or <CODE>HWC24_MSGTYPE_WII_MENU</CODE> specified.)
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">
32Pointer to the object storing the meta-data of the retrieved message.<BR>
33    </TD>
34  </TR>
35  <TR>
36<TD width="120" bgcolor="#ffffe8"><code><em><strong>mboxId</strong></em></code></TD>
37    <TD width="520">
38Message box type (NWC24_SEND_BOX/NWC24_RECV_BOX).
39    </TD>
40  </TR>
41  <TR>
42<TD width="120" bgcolor="#ffffe8"><code><em><strong>msgId</strong></em></code></TD>
43    <TD width="520">
44ID of the retrieved message.<BR>
45    </TD>
46  </TR>
47</TABLE>
48
49<h2>Return Values</h2>
50<P>
51<code>NWC24_OK</code>: Normal exit (message data is unpacked into *<code><em><strong>obj</strong></em></code>).<BR> <code>NWC24_ERR_HIDDEN</code>: The message cannot be accessed from the application currently running.<BR> <code>NWC24_ERR_LIB_NOT_OPENED</code>: Library not open.<BR> <code>NWC24_ERR_INVALID_VALUE</code>: A value other than <code>NWC24_SEND_BOX</code> or <code>NWC24_RECV_BOX</code> has been specified for <code><em><strong>mboxId</strong></em></code>.<BR> <code>NWC24_ERR_NOT_FOUND</code>: The message given by <code><em><strong>msgId</strong></em></code> does not exist in the message box.<BR> <code>NWC24_ERR_FILE_*</code>: Error related to internal file processing.<BR> <code>NWC24_ERR_VER_MISMATCH</code>: Message box version error.<BR>
52</P>
53
54<H2>See Also</H2>
55<P>
56</P>
57
58<H2>Revision History</H2>
59<P>
602006/11/09 Added description about HIDDEN errors.<BR> 2006/10/06 Updated return value list.<BR> 2006/08/01 Initial version.
61</P>
62
63<hr><p>CONFIDENTIAL</p></body>
64</HTML>