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>NWC24SetMsgTag</TITLE>
7<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
8</HEAD>
9<BODY>
10<H1>NWC24SetMsgTag</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> NWC24SetMsgTag( <A HREF="../Types/NWC24MsgObj.html">NWC24MsgObj</A>* <EM>obj</EM>, u16 <EM>tag</EM> );</CODE></PRE>
16</DL>
17
18<H2>Description</H2>
19<P>
20Sets a tag for the message.<BR>The tag can be set to any value from 1 to 65535. Messages for which a tag is set undergo the following processing when saved to the inbox of the device that receives the message:<br>
21</P>
22<P>
23<UL>
24<LI>If a message having the same sender, application ID, and tag number does not exist in the inbox, the message is stored in the inbox as-is.<br>
25<LI>If a message that has the same sender, application ID, and tag number already exists in the inbox, the message already stored is deleted, and only the new message received is stored.<br>
26</UL>
27</P>
28<P>
29This mechanism enables an application to save no more than one message in the inbox at any given time, even though a message is issued every time an update occurs. This would apply to data such as a high score, for which only the latest data has any meaning.<br><BR> <B></B>A tag is not set when zero is specified for <code><em><strong>tag</strong></em></code>.<BR>
30</P>
31
32<H2>Arguments</H2>
33<TABLE border="1" cellpadding="3" cellspacing="0.1">
34  <TR>
35<TD width="120" bgcolor="#ffffe8"><code><em><strong><em><strong><code>obj</code></strong></em></strong></em></code></TD>
36    <TD width="520">
37Pointer to the message object to be set.
38    </TD>
39  </TR>
40  <TR>
41<TD width="120" bgcolor="#ffffe8"><code><em><strong><STRONG><EM><CODE>tag</CODE></EM></STRONG></strong></em></code></TD>
42    <TD width="520">
43Tag to be set for the message.
44    </TD>
45  </TR>
46</TABLE>
47
48<h2>Return Values</h2>
49<P>
50<code>NWC24_OK</code>: Normal termination.<BR> <code>NWC24_ERR_PROTECTED</code>: Cannot change message object.<BR> <code>NWC24_ERR_NOT_SUPPORTED</code>: Something other than a message object was specified for <code><em><strong>obj</strong></em></code>.<BR>
51</P>
52
53<H2>See Also</H2>
54<P>
55<A href="NWC24InitMsgObj.html"><CODE>NWC24InitMsgObj</CODE></A>, <A href="NWC24GetMsgTag.html"><CODE>NWC24GetMsgTag</CODE></A>
56</P>
57
58<H2>Revision History</H2>
59<P>2006/10/06 Initial version.</P>
60
61<hr><p>CONFIDENTIAL</p></body>
62</HTML>