DWC_SavePrivateDataAsync

Syntax

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

Arguments

keyvalues Pointer to the database string (a key/value pair).
param Callback parameter.

Return Values

TRUE Starting the save process.
FALSE Cannot save because either the system is offline or an error is being generated.

Description

Saves the data that can be referenced only by the player to the data storage server. The data to be saved must be a string that ends with the null terminator and is a combination of key/value pairs.

The keyvalues argument denotes a string using "\" as a delimiter, as in "\name\mario\stage\3". This allows multiple key/value pairs to be saved at once, such as in the example just cited.

Once data has been saved, the save completion notification callback specified by the DWC_SetStorageServerCallback function is called.

If an empty value such as "\\name\\" is saved for value, key can be erased.
Although the erased key cannot be referenced, it remains on the data storage server. Therefore, if a large number of keys are erased this way, it will unnecessarily consume data storage server space.

Asynchronous processes related to storage may never reach completion if, for example, communications are cut. For this reason, configure a timeout in the application (approximately 1 minute, if several KB are being stored), or implement some means for the user to cancel the process. To cancel the process, call the DWC_LogoutFromStorageServer function.

Revision History

For the changelog prior to 5.1 PR2, click here.


CONFIDENTIAL