1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META http-equiv="Content-Style-Type" content="text/css">
7<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows">
8<title>DWC_CfSetAppFriendKeyToNWC24Msg</title>
9<LINK rel="stylesheet" href="../css/nitro.css" type="text/css">
10</head>
11
12<body>
13<a name="dwc__cfriend_8h_1eb5fe832e0b22bf3dd5da084a1fcb07d"></a>
14<h1 align="left">DWC_CfSetAppFriendKeyToNWC24Msg</h1>
15<h2>Syntax</h2>
16
17<dl>
18  <dd>
19<CODE>#include &lt;dwc.h&gt;</CODE><BR>
20  <BR>
21  <PRE><CODE><a href=Macro.html#dwc__cfriend_8h_1ccfc9575a5d094b20e4b1227b599a8d5>DWCCfError</a> <a href=DWC_CfSetAppFriendKeyToNWC24Msg.html#dwc__cfriend_8h_1eb5fe832e0b22bf3dd5da084a1fcb07d>DWC_CfSetAppFriendKeyToNWC24Msg</a>(NWC24MsgObj *obj,
22                                           const DWCUserData *userdata,
23                                           <a href=Macro.html#dwc__cfriend_8h_161bb5550c8362a5fc91a659a8ea1d971>DWCCfMsgType</a> msgType);</CODE></PRE></dd>
24</dl>
25
26<h2>Arguments</h2>
27
28<TABLE border="1" width="100%">
29  <TBODY>
30
31    <TR>
32<TD width="13%"><EM><STRONG>obj</STRONG></EM></TD>
33<TD width="87%">Pointer to <CODE>NWC24MsgObj</CODE> to which to append the game Friend code.</TD>
34    </TR>
35
36    <TR>
37<TD width="13%"><EM><STRONG>userdata</STRONG></EM></TD>
38<TD width="87%">Own user data. Ignored when <CODE>msgType</CODE> is <a href=Macro.html#dwc__cfriend_8h_161bb5550c8362a5fc91a659a8ea1d97126526dbbbe3993fcd3d3a00f1a2c493b><CODE>DWC_CF_MSG_TYPE_RESPONSE_DENY</CODE></a>.</TD>
39    </TR>
40
41    <TR>
42<TD width="13%"><EM><STRONG>msgType</STRONG></EM></TD>
43<TD width="87%">Message type.</TD>
44    </TR>
45
46  </TBODY>
47</TABLE>
48
49<h2>Return Values</h2>
50
51<TABLE border="1" width="100%">
52  <TBODY>
53
54    <TR>
55<TD width="13%"><EM><STRONG>DWC_CF_ERROR_NONE</STRONG></EM></TD>
56<TD width="87%">Succeeded.</TD>
57    </TR>
58
59    <TR>
60<TD width="13%"><EM><STRONG>Other</STRONG></EM></TD>
61<TD width="87%">The <a href=Macro.html#dwc__cfriend_8h_1ccfc9575a5d094b20e4b1227b599a8d5><CODE>DWCCfError</CODE></a> enumerated type which indicates the error code.</TD>
62    </TR>
63
64  </TBODY>
65</TABLE>
66
67<H2>Description</H2>
68<p>Appends information for game Friend exchanges to a <CODE>NWC24MsgObj</CODE> .</p><p>If never logged in before, the function will not be able to create a Friend code from the user data, and will fail.</p><p>Approximately 24 bytes of memory are consumed dynamically every time this function is called. This memory region gets released when the <A href="DWC_Shutdown.html"><CODE>DWC_Shutdown</CODE></a> is called.</p><p>If you want to explicitly release the region, call the <A href="DWC_CfReset.html"><CODE>DWC_CfReset</CODE></a> function. However, the memory can only be released after <CODE>NWC24CommitMsg</CODE> has been called for the <CODE>NWC24MsgObj</CODE> to which information was appended for game Friend exchanges.</p><p>There is a limit on the amount of binary data that can be appended to an <CODE>NWC24MsgObj</CODE>, so the function will fail if that limit has already been reached when the function is called.</p><p>Only one set of information for game Friend exchanges can be appended to each <CODE>NWC24MsgObj</CODE>. When this function is called multiple times for the same <CODE>NWC24MsgObj</CODE>, the error <a href=Macro.html#dwc__cfriend_8h_1ccfc9575a5d094b20e4b1227b599a8d549ac9caa58e78906d0f6ecae3cd1a42d><CODE>DWC_CF_ERROR_MSGOBJ_ALREADY_SET</CODE></a> will be returned.</p>
69
70<H2>Revision History</H2>
71<DL>
72
73<DT><para>1.4.1</DT>
74<DD>Corrected the description of the return values</DD>
75
76<DT><para>1.4.0</DT>
77<DD>Created initial version</DD>
78
79</DL>
80<hr><p>CONFIDENTIAL</p></body>
81</html>
82