DWC_AddCommonKeyValueString

Syntax


#include <dwc.h>

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

Description

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

The key/value string consists of a string specified by key and a string specified by value; to indicate the start of each character string, the separator character is added for use as a symbol.

For example, when calling this function by specifying string = "/key1/value1", key = "key2", value = "value2", and separator = '/', the character string "/key1/value1/key2/value2" is returned to string.

This is useful in the creation of save data for the data storage server. For more information about the data storage server, see functions DWC_SavePublicDataAsync and DWC_SavePrivateDataAsync.

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 when creating a key/value character string. In addition, to get the value string that corresponds to a specific key string from the key/value string, use the DWC_GetCommonValueString function.

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 a character string that is set in the string (NULL terminator is not included).

See Also

DWC_SetCommonKeyValueString
DWC_GetCommonValueString
DWC_SavePublicDataAsync
DWC_SavePrivateDataAsync

Revision History

2005/12/16 Initial version.


CONFIDENTIAL