DWC_AddCommonKeyValueString

Syntax

#include <dwc.h>

int DWC_AddCommonKeyValueString(const char *key,
                                const char *value,
                                char *string,
                                char separator);

Arguments

key The pointer to the key character string to add.
value The pointer to the value character string to add.
string The pointer to the character string to which the key/value character string is to be added.
separator Character used to indicate the start of each of the character strings in the key/value character string.

Return Values

Returns the length of the character string set in string (not including the NULL terminator).

Description

This function adds a key/value character string to the end of a character string.

The key/value string consists of the string specified by key and the string specified by value with the separator character added as a symbol to indicate the start of each character string.

For example, if this function is called specifying string = "/key1/value1", key = "key2", value = "value2", and separator = '/', the string "/key1/value1/key2/value2" will be returned in string.

This is useful when creating the save data for the data storage server. See the functions DWC_SavePublicDataAsync and DWC_SavePrivateDataAsync for further information about saving to the data storage server.

A key/value character string with a maximum of 4096 characters (including the NULL terminator) can be added at one time.

Use the DWC_SetCommonKeyValueString function when creating a key/value character string. Also, use the DWC_GetCommonValueString function to get the value string that corresponds to a specific key string from the key/value string.

Revision History


CONFIDENTIAL