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_LoadOthersDataAsync</title>
9<LINK rel="stylesheet" href="../css/nitro.css" type="text/css">
10</head>
11
12<body>
13<a name="dwc__datastorage_8h_173f74fbd1c8a762a00b4e49a77b01d2e"></a>
14<h1 align="left">DWC_LoadOthersDataAsync</h1>
15<h2>Syntax</h2>
16
17<dl>
18  <dd>
19<CODE>#include &lt;dwc.h&gt;</CODE><BR>
20  <BR>
21  <PRE><CODE>BOOL <a href=DWC_LoadOthersDataAsync.html#dwc__datastorage_8h_173f74fbd1c8a762a00b4e49a77b01d2e>DWC_LoadOthersDataAsync</a>(char *keys,
22                             int index,
23                             void *param);</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>keys</STRONG></EM></TD>
33<TD width="87%">Pointer to the key string for the data to load.</TD>
34    </TR>
35
36    <TR>
37<TD width="13%"><EM><STRONG>index</STRONG></EM></TD>
38<TD width="87%">The user's friend roster index to be load.</TD>
39    </TR>
40
41    <TR>
42<TD width="13%"><EM><STRONG>param</STRONG></EM></TD>
43<TD width="87%">Callback parameter.</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>TRUE</STRONG></EM></TD>
56<TD width="87%">Starting load.</TD>
57    </TR>
58
59    <TR>
60<TD width="13%"><EM><STRONG>FALSE</STRONG></EM></TD>
61<TD width="87%">Cannot load because the system is offline, the partner is not a friend, or an error is being generated.</TD>
62    </TR>
63
64  </TBODY>
65</TABLE>
66
67<H2>Description</H2>
68<p>Loads the data that was saved by someone else with the <CODE><A href="DWC_SavePublicDataAsync.html">DWC_SavePublicDataAsync</A></CODE> function from the data storage server. Be aware that it is possible to load data even if a friend relationship has not been established. (The friend information data type is a friend registry key.)</p><p>The data for loading is specified in <CODE>keys</CODE>. It must be a NULL-terminated character string. <CODE>keys</CODE> is written using &quot;<CODE>\</CODE>&quot; as a delimiter, as in &quot;<CODE>\name\stage</CODE>&quot;. This allows multiple keys to be loaded at once, as in the example just cited. Once data loading is complete, the load completion notification callback specified by <CODE><A href="DWC_SetStorageServerCallback.html">DWC_SetStorageServerCallback</A></CODE> is called.</p><p>When trying to load non-existent keys or only keys saved by a friend with the <CODE><A href="DWC_SavePrivateDataAsync.html">DWC_SavePrivateDataAsync</A></CODE> function, the callback argument <CODE>success</CODE> becomes FALSE. However, if only some of the specified keys fall into this category, they will not be included in the load data, and the <CODE>success</CODE> argument will be TRUE.</p><p>The callback might not be called if, during loading, a disconnect occurs in an upper circuit on the router. Be sure to set up a timeout within the application or use an interface that allows the user to cancel.</p><p>Call the <CODE>LogoutFromStorageServer</CODE> function to cancel.</p>
69
70<H2>Revision History</H2>
71<DL>
72
73<DT><para>1.4.12</DT>
74<DD>Added information specific to implementation of canceling.</DD>
75
76</DL>
77<hr><p>CONFIDENTIAL</p></body>
78</html>
79