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_LoadOwnPrivateDataAsync</title>
9<LINK rel="stylesheet" href="../css/nitro.css" type="text/css">
10</head>
11
12<body>
13<a name="dwc__datastorage_8h_16e5d43d5b96b77bc36632fcfeac46260"></a>
14<h1 align="left">DWC_LoadOwnPrivateDataAsync</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_LoadOwnPrivateDataAsync.html#dwc__datastorage_8h_16e5d43d5b96b77bc36632fcfeac46260>DWC_LoadOwnPrivateDataAsync</a>(char *keys,
22                                 void *param);</CODE></PRE></dd>
23</dl>
24
25<h2>Arguments</h2>
26
27<TABLE border="1" width="100%">
28  <TBODY>
29
30    <TR>
31<TD width="13%"><EM><STRONG>keys</STRONG></EM></TD>
32<TD width="87%">Pointer to the key string for the data to load.</TD>
33    </TR>
34
35    <TR>
36<TD width="13%"><EM><STRONG>param</STRONG></EM></TD>
37<TD width="87%">Callback parameter.</TD>
38    </TR>
39
40  </TBODY>
41</TABLE>
42
43<h2>Return Values</h2>
44
45<TABLE border="1" width="100%">
46  <TBODY>
47
48    <TR>
49<TD width="13%"><EM><STRONG>TRUE</STRONG></EM></TD>
50<TD width="87%">Starting load.</TD>
51    </TR>
52
53    <TR>
54<TD width="13%"><EM><STRONG>FALSE</STRONG></EM></TD>
55<TD width="87%">Cannot load because either the system is offline or an error is being generated.</TD>
56    </TR>
57
58  </TBODY>
59</TABLE>
60
61<H2>Description</H2>
62<p>This function loads this host's own data, that was saved using the <A href="DWC_SavePrivateDataAsync.html"><CODE>DWC_SavePrivateDataAsync</CODE></A> function, from the data storage server. 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 with the <CODE><A href="DWC_SavePublicDataAsync.html">DWC_SavePublicDataAsync</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>
63
64<H2>Revision History</H2>
65<DL>
66
67<DT><para>1.4.12</DT>
68<DD>Added information specific to implementation of canceling.</DD>
69
70</DL>
71<hr><p>CONFIDENTIAL</p></body>
72</html>
73