DWC_LoadOwnPrivateDataAsync

Syntax

#include <dwc.h>
BOOL DWC_LoadOwnPrivateDataAsync(char *keys,
                                 void *param);

Arguments

keys Pointer to the key string for the data to be loaded.
param Callback parameter

Return Values

TRUE Starting load.
FALSE Cannot load because either the DS is offline or an error is being generated.

Description

Loads the local host's data (saved using the DWC_SavePrivateDataAsync function) from the data storage server. The data for loading is specified in keys and must be a null-terminated string.
The keys string is written using "\" as a delimiter, as in "\name\stage". This allows multiple keys to be loaded at once, as in this example. Once data loading is complete, the load completion notification callback specified by DWC_SetStorageServerCallback is called.

When trying to load only non-existent keys or keys saved with the DWC_SavePublicDataAsync function, the callback argument success returns FALSE. However, if only some of the specified keys fall into this category, they are not included in the load data, and the success argument is TRUE.

The callback might not be called in situations such as when a disconnection occurs somewhere upstream from the router during loading. Accordingly, on the application side, you must implement timeouts or an interface that allows the user to cancel.

Call the DWC_LogoutFromStorageServer function to cancel.

Revision History

For the changelog prior to 5.1 PR2, click here.


CONFIDENTIAL