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>NWC24WriteFriendInfo</TITLE>
7<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
8</HEAD>
9<BODY>
10<H1>NWC24WriteFriendInfo</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> NWC24WriteFriendInfo( const <A HREF="../Types/NWC24FriendInfo.html">NWC24FriendInfo</A>* <EM>info</EM>, u32 <EM>index</EM> );</CODE></PRE>
16</DL>
17
18<H2>Description</H2>
19<P>
20Stores information within the main friends list at the <code><em><strong>index</strong></em></code> position.
21</P>
22<P>
23<B>Note: </B>This function is released for testing during development. Unless you have a special reason, do not incorporate this function into the production version of your application.
24</P>
25
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>info</strong></em></code></TD>
31    <TD width="520">
32The <A HREF="../Types/NWC24FriendInfo.html">NWC24FriendInfo structure</A> that holds the information to be stored. (Must be 32-byte aligned.)
33    </TD>
34  </TR>
35  <TR>
36<TD width="120" bgcolor="#ffffe8"><code><em><strong>index</strong></em></code></TD>
37    <TD width="520">
38The index within the friend roster.
39    </TD>
40  </TR>
41</TABLE>
42
43<h2>Return Values</h2>
44<P>
45<code>NWC24_OK</code>: Stored normally.<BR><code>NWC24_ERR_FULL</code>: Information is already registered in the specified index location.<BR><code>NWC24_ERR_ALIGNMENT</code>: The <code><em><strong>info</strong></em></code> argument is not 32-byte aligned.<BR><code>NWC24_ERR_STRING_END</code>: The nickname set in <code><em><strong>info</strong></em></code> exceeds 11 characters, or the e-mail address exceeds 255 characters.<BR><code>NWC24_ERR_ID_CRC</code>: The CRC of the user ID set in <code><em><strong>info</strong></em></code> is incorrect.<BR><code>NWC24_ERR_INVALID_VALUE</code>: The value of <code><em><strong>index</strong></em></code> or <code><em><strong>info</strong></em></code> is invalid.<BR><code>NWC24_ERR_LIB_NOT_OPENED</code>: Library is not open.<BR><code>NWC24_ERR_FILE_*</code>: File access error.<BR><code>NWC24_ERR_BROKEN</code>: Friend roster broken.<BR><code>NWC24_ERR_VER_MISMATCH</code>: Friend roster version error.<BR>
46</P>
47
48<H2>See Also</H2>
49<P>
50<A href="NWC24ReadFriendInfo.html"><CODE>NWC24ReadFriendInfo</CODE></A>, <A href="NWC24UpdateFriendInfo.html"><CODE>NWC24UpdateFriendInfo</CODE></A>, <A href="NWC24DeleteFriendInfo.html"><CODE>NWC24DeleteFriendInfo</CODE></A>, <A href="NWC24SearchFriendInfoById.html"><CODE>NWC24SearchFriendInfoById</CODE></A>, <A href="NWC24IsFriendInfoThere.html"><CODE>NWC24IsFriendInfoThere</CODE></A>
51</P>
52
53<H2>Revision History</H2>
54<P>
552007/04/04 Added a note of caution about using this function in the production version.<BR> 2007/02/23 Corrected errors.<BR> 2006/10/06 Updated the list of return values.<BR> 2006/09/01 Initial version.
56</P>
57
58<hr><p>CONFIDENTIAL</p></body>
59</HTML>