DWC_SetCommonKeyValueString

C Specification


#include <dwc.h>

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

Description

This function creates key/value character strings.

The key/value string is a string consisting 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 the character strings.

For example, specifying key = "key1", value = "value1", and separator = '/', the character string "/key1/value1" is returned to 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 the data storage server.

Altogether, up to 4096 characters (including the NULL end-of-string character) can be used in creating the key/value character string.

To add more key/value character strings to this character string, use the DWC_AddCommonKeyValueString function. Also, use the DWC_GetCommonValueString function to obtain the value string corresponding to a specific key string from the key/value string.

Arguments

key The pointer to the key character string to be set.
value The pointer to the value character string to be set.
string The pointer to the location where the created key/value character string is stored.
separator A 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 end-of-string character).

See Also

DWC_AddCommonKeyValueString, DWC_GetCommonValueString, DWC_SavePublicDataAsync, DWC_SavePrivateDataAsync,

Revision History

12/16/2005 Initial version.