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>NWC24SetMsgSubject</TITLE>
7<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
8</HEAD>
9<BODY>
10<H1>NWC24SetMsgSubject</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> NWC24SetMsgSubject( <A HREF="../Types/NWC24MsgObj.html">NWC24MsgObj</A>* <EM>obj</EM>, const char* <EM>subject</EM>, u32 <EM>size</EM> );</CODE></PRE>
16</DL>
17
18<H2>Description</H2>
19<P>
20Specifies the message subject with a string.
21</P>
22<P>
23The string provided here must use 7-bit coded characters only. When a Wii message is displayed on the Wii Message Board, the subject is ignored. When sending a string with UTF-16BE encoding, which is an internal character encoding, in a public message, use the <A HREF="NWC24SetMsgSubjectPublic.html"><CODE>NWC24SetMsgSubjectPublic</CODE></A> function to perform character code conversion for the header and MIME encoding.
24</P>
25
26<P>
27For reasons of internal processing, the data size that can be specified by <CODE><EM><STRONG>size</STRONG></EM></CODE> is limited to a maximum of 1,012 bytes.
28</P>
29
30<P>
31The buffer given by the <CODE><EM><STRONG>subject</STRONG></EM></CODE> argument is not freed until <A HREF="NWC24CommitMsg.html"><CODE>NWC24CommitMsg()</CODE></A> is called and creation of the message is complete.
32</P>
33
34<H2>Arguments</H2>
35<TABLE border="1" cellpadding="3" cellspacing="0.1">
36  <TR>
37<TD width="120" bgcolor="#ffffe8"><code><em><strong>obj</strong></em></code></TD>
38    <TD width="520">
39Pointer to the message object to be set.
40    </TD>
41  </TR>
42  <TR>
43<TD width="120" bgcolor="#ffffe8"><code><em><strong>subject</strong></em></code></TD>
44    <TD width="520">
45Pointer to the subject string.
46    </TD>
47  </TR>
48  <TR>
49<TD width="120" bgcolor="#ffffe8"><code><em><strong>size</strong></em></code></TD>
50    <TD width="520">
51Length of the string specified in <code><em><strong>subject</strong></em></code>.
52    </TD>
53  </TR>
54</TABLE>
55
56<h2>Return Values</h2>
57<P>
58<code>NWC24_OK</code>: Normal termination.<BR> <code>NWC24_ERR_PROTECTED</code>: Cannot change message object.<BR> <code>NWC24_ERR_NULL</code>: The <code><em><strong>subject</strong></em></code> argument is a null pointer, or the subject title is empty.<BR> <code>NWC24_ERR_OVERFLOW</code>: The value of <code><em><strong>size</strong></em></code> exceeds the size that can be processed.<BR>
59</P>
60
61<H2>See Also</H2>
62<P>
63<A href="NWC24InitMsgObj.html"><CODE>NWC24InitMsgObj</CODE></A>
64</P>
65
66<H2>Revision History</H2>
67<P>
682007/07/18 Added text regarding size restrictions. Added <code>NWC24_ERR_OVERFLOW</code> to the return values and deleted <code>NWC24_ERR_STRING_END</code>.<BR>2007/01/31 Added text about sending public messages.<BR>2006/11/13 Added text about handling buffers.<BR> 2006/10/06  Updated the Return Values.<BR>2006/08/01 Initial version.
69</P>
70
71<hr><p>CONFIDENTIAL</p></body>
72</HTML>