1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META http-equiv="Content-Style-Type" content="text/css">
7<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows">
8<title>DWC_GetCommonValueString</title>
9<LINK rel="stylesheet" href="../css/nitro.css" type="text/css">
10</head>
11
12<body>
13<a name="dwc__common_8h_1ccb38a8c74cfbd013fb1b1cca709fada"></a>
14<h1 align="left">DWC_GetCommonValueString</h1>
15<h2>Syntax</h2>
16
17<dl>
18  <dd>
19<CODE>#include &lt;dwc.h&gt;</CODE><BR>
20  <BR>
21  <PRE><CODE>int <a href=DWC_GetCommonValueString.html#dwc__common_8h_1ccb38a8c74cfbd013fb1b1cca709fada>DWC_GetCommonValueString</a>(const char *key,
22                             char *value,
23                             const char *string,
24                             char separator);</CODE></PRE></dd>
25</dl>
26
27<h2>Arguments</h2>
28
29<TABLE border="1" width="100%">
30  <TBODY>
31
32    <TR>
33<TD width="13%"><EM><STRONG>key</STRONG></EM></TD>
34<TD width="87%">Pointer to the key string corresponding to the value string you want to get.</TD>
35    </TR>
36
37    <TR>
38<TD width="13%"><EM><STRONG>value</STRONG></EM></TD>
39<TD width="87%">Pointer to the storage destination of the value string you want to get.</TD>
40    </TR>
41
42    <TR>
43<TD width="13%"><EM><STRONG>string</STRONG></EM></TD>
44<TD width="87%">Pointer to the key/value string.</TD>
45    </TR>
46
47    <TR>
48<TD width="13%"><EM><STRONG>separator</STRONG></EM></TD>
49<TD width="87%">Character used to indicate the start of each of the character strings in the key/value character string.</TD>
50    </TR>
51
52  </TBODY>
53</TABLE>
54
55<h2>Return Values</h2>
56
57<p>Returns the length of the character string in <CODE>value</CODE> (not including the NULL terminator). If a non-existent <CODE>key</CODE> is specified, -1 is returned.</p>
58
59<H2>Description</H2>
60<p>Gets the <CODE>value</CODE> string corresponding to the string specified with <CODE>key</CODE> from the key/value string specified with <CODE>string</CODE>.</p><p>The key/value string consists of the string specified by <CODE>key</CODE> and the string specified by <CODE>value</CODE> with the <CODE>separator</CODE> character added as a symbol to indicate the start of each character string.</p><p>For example, when calling this function and specifying <CODE>string=&quot;/key1/value1/key2/value2&quot;</CODE>, <CODE>key=&quot;key1&quot;</CODE>, and <CODE>separator='/'</CODE>, the character string <CODE>&quot;value1&quot;</CODE> is returned to <CODE>value</CODE>.</p><p>This is useful when creating the save data for the data storage server. See the functions <a href=DWC_SavePublicDataAsync.html#dwc__datastorage_8h_172b3cdde2638884709ae0c6c5ab68ba7><CODE>DWC_SavePublicDataAsync</CODE></a> and <a href=DWC_SavePrivateDataAsync.html#dwc__datastorage_8h_1982adb8b9c1f01095b7acf2496f3390a><CODE>DWC_SavePrivateDataAsync</CODE></a> for further information about saving to the data storage server.</p><p>Use the <A href="DWC_SetCommonKeyValueString.html"><CODE>DWC_SetCommonKeyValueString</CODE></a> / <A href="DWC_AddCommonKeyValueString.html"><CODE>DWC_AddCommonKeyValueString</CODE></a> functions to create a key/value character string.</p>
61
62<H2>Revision History</H2>
63<DL>
64
65</DL>
66<hr><p>CONFIDENTIAL</p></body>
67</html>
68