Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>TB9.2 Example Applications: examples/PIPS/OpenCStringUtilitiesEx/library/inc/stringutils.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<div class="contents">
<h1>examples/PIPS/OpenCStringUtilitiesEx/library/inc/stringutils.h File Reference</h1>
<p><a href="stringutils_8h_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="stringutils_8h.html#a0fcdfc9f202050b7e5a2cd54da14d2fe">hbufC16towchar</a> tbufC16towchar</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="stringutils_8h.html#ac8c22cd9144639f951b2193e373f0d2f">hbufC16tochar</a> tbufC16tochar</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="stringutils_8h.html#a88565a9ed99585f8391862e7f5b4d17c">hbufC8towchar</a> tbufC8towchar</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="stringutils_8h.html#a6319f08fa6eea77d034e46eaa60584b0">hbufC8tochar</a> tbufC8tochar</td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C wchar_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="stringutils_8h.html#a9d3907ae46af2842f427b5c58fe6ac60">tbuf16towchar</a> (TDes &aArg)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C char * </td><td class="memItemRight" valign="bottom"><a class="el" href="stringutils_8h.html#a92e6d0f669d9f15f18c3789ddf5ca779">tbuf8tochar</a> (TDes8 &aArg)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C int </td><td class="memItemRight" valign="bottom"><a class="el" href="stringutils_8h.html#a8d9e370a0c317212eb7193988b2702cf">tbuf16tochar</a> (TDes &aSrc, char *aDes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C int </td><td class="memItemRight" valign="bottom"><a class="el" href="stringutils_8h.html#ac6ce874e6902d0d6f6142e6660866fcc">tbuf8towchar</a> (TDes8 &aSrc, wchar_t *aDes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="stringutils_8h.html#a9e6c0fa268a62a4facea28cb5a83bfcb">tbufC16towchar</a> (TDesC &aSrc, wchar_t *aDes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="stringutils_8h.html#a06e4914590a9e3b316c972dd598e2024">tbufC8tochar</a> (TDesC8 &aSrc, char *aDes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C int </td><td class="memItemRight" valign="bottom"><a class="el" href="stringutils_8h.html#a760b3acc819bce96dcc444b61e18985d">tbufC16tochar</a> (TDesC &aSrc, char *aDes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C int </td><td class="memItemRight" valign="bottom"><a class="el" href="stringutils_8h.html#a756faf258af3a7d145afdf8ad9032908">tbufC8towchar</a> (TDesC8 &aSrc, wchar_t *aDes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="stringutils_8h.html#af57eac18681e12a2a2579a46f900c531">wchartotbuf16</a> (const wchar_t *aSrc, TDes16 &aDes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C int </td><td class="memItemRight" valign="bottom"><a class="el" href="stringutils_8h.html#aa5c2923704de78bc06da21acae819bc7">chartotbuf16</a> (const char *aSrc, TDes16 &aDes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C int </td><td class="memItemRight" valign="bottom"><a class="el" href="stringutils_8h.html#a74d0bc81ee2e712248f5c18b23411100">wchartotbuf8</a> (const wchar_t *aSrc, TDes8 &aDes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae480568848ef19f670180ea3dbcf5c5b"></a><!-- doxytag: member="stringutils.h::chartotbuf8" ref="ae480568848ef19f670180ea3dbcf5c5b" args="(const char *aSrc, TDes8 &aDes)" -->
IMPORT_C void </td><td class="memItemRight" valign="bottom"><b>chartotbuf8</b> (const char *aSrc, TDes8 &aDes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="stringutils_8h.html#a328900ebbbca3b494bd356d272433892">wchartohbufc16</a> (const wchar_t *aSrc, HBufC16 &aDes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C int </td><td class="memItemRight" valign="bottom"><a class="el" href="stringutils_8h.html#aecde687b6096958e753361b93a22ba23">chartohbufc16</a> (const char *aSrc, HBufC16 &aDes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C int </td><td class="memItemRight" valign="bottom"><a class="el" href="stringutils_8h.html#ab28f816757c669da455d3112bc013a75">wchartohbufc8</a> (const wchar_t *aSrc, HBufC8 &aDes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a10befaf412b57d59eb680ab10caa9c01"></a><!-- doxytag: member="stringutils.h::chartohbufc8" ref="a10befaf412b57d59eb680ab10caa9c01" args="(const char *aSrc, HBufC8 &aDes)" -->
IMPORT_C void </td><td class="memItemRight" valign="bottom"><b>chartohbufc8</b> (const char *aSrc, HBufC8 &aDes)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>stringutils is a DLL that exports some set of genaralized APIs using which user can convert the SYMBIAN descriptors to standard C character/wide-character strings and vice-versa </p>
<p>Definition in file <a class="el" href="stringutils_8h_source.html">stringutils.h</a>.</p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="a0fcdfc9f202050b7e5a2cd54da14d2fe"></a><!-- doxytag: member="stringutils.h::hbufC16towchar" ref="a0fcdfc9f202050b7e5a2cd54da14d2fe" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define hbufC16towchar tbufC16towchar</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Aliases : Cconverting HBufC variants to char/wchar_t strings involves similiar procedure to that of converting TBufC variants to char/wchar_t strings. Hence HBufC to char/wchar_t conversion Apis are aliased to their corresponding TBufC counterparts Alias to the function tbufC16towchar </p>
<p>Definition at line <a class="el" href="stringutils_8h_source.html#l00040">40</a> of file <a class="el" href="stringutils_8h_source.html">stringutils.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac8c22cd9144639f951b2193e373f0d2f"></a><!-- doxytag: member="stringutils.h::hbufC16tochar" ref="ac8c22cd9144639f951b2193e373f0d2f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define hbufC16tochar tbufC16tochar</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Alias to the function tbufC16tochar </p>
<p>Definition at line <a class="el" href="stringutils_8h_source.html#l00044">44</a> of file <a class="el" href="stringutils_8h_source.html">stringutils.h</a>.</p>
</div>
</div>
<a class="anchor" id="a88565a9ed99585f8391862e7f5b4d17c"></a><!-- doxytag: member="stringutils.h::hbufC8towchar" ref="a88565a9ed99585f8391862e7f5b4d17c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define hbufC8towchar tbufC8towchar</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Alias to the function tbufC8towchar </p>
<p>Definition at line <a class="el" href="stringutils_8h_source.html#l00048">48</a> of file <a class="el" href="stringutils_8h_source.html">stringutils.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6319f08fa6eea77d034e46eaa60584b0"></a><!-- doxytag: member="stringutils.h::hbufC8tochar" ref="a6319f08fa6eea77d034e46eaa60584b0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define hbufC8tochar tbufC8tochar</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Alias to the function tbufC8tochar </p>
<p>Definition at line <a class="el" href="stringutils_8h_source.html#l00052">52</a> of file <a class="el" href="stringutils_8h_source.html">stringutils.h</a>.</p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a9d3907ae46af2842f427b5c58fe6ac60"></a><!-- doxytag: member="stringutils.h::tbuf16towchar" ref="a9d3907ae46af2842f427b5c58fe6ac60" args="(TDes &aArg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IMPORT_C wchar_t* tbuf16towchar </td>
<td>(</td>
<td class="paramtype">TDes & </td>
<td class="paramname"> <em>aArg</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Functions to convert SYMBIAN descriptors to C character and Wide-Character strings This Api converts the tbuf16 to a wide-character string </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aArg</em> </td><td>TDes object </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to a wide-character string </dd></dl>
<p>Definition at line <a class="el" href="stringutils_8cpp_source.html#l00029">29</a> of file <a class="el" href="stringutils_8cpp_source.html">stringutils.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a92e6d0f669d9f15f18c3789ddf5ca779"></a><!-- doxytag: member="stringutils.h::tbuf8tochar" ref="a92e6d0f669d9f15f18c3789ddf5ca779" args="(TDes8 &aArg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IMPORT_C char* tbuf8tochar </td>
<td>(</td>
<td class="paramtype">TDes8 & </td>
<td class="paramname"> <em>aArg</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This Api converts the tbuf8 to a character string </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aArg</em> </td><td>TDes8 object </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to a character string </dd></dl>
<p>Definition at line <a class="el" href="stringutils_8cpp_source.html#l00034">34</a> of file <a class="el" href="stringutils_8cpp_source.html">stringutils.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8d9e370a0c317212eb7193988b2702cf"></a><!-- doxytag: member="stringutils.h::tbuf16tochar" ref="a8d9e370a0c317212eb7193988b2702cf" args="(TDes &aSrc, char *aDes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IMPORT_C int tbuf16tochar </td>
<td>(</td>
<td class="paramtype">TDes & </td>
<td class="paramname"> <em>aSrc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>aDes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This Api converts the tbuf16 to a character string. It is user responsibality to allocate a required size of char object. Api may resulting in crash, if the destination object size is smaller than that of the source. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aSrc</em> </td><td>TDes16 object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aDes</em> </td><td>character pointer, to which the resultant string will be copied. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>returns an integer value. </dd>
<dd>
Api returns -1 in case of any error. </dd></dl>
<p>Definition at line <a class="el" href="stringutils_8cpp_source.html#l00039">39</a> of file <a class="el" href="stringutils_8cpp_source.html">stringutils.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac6ce874e6902d0d6f6142e6660866fcc"></a><!-- doxytag: member="stringutils.h::tbuf8towchar" ref="ac6ce874e6902d0d6f6142e6660866fcc" args="(TDes8 &aSrc, wchar_t *aDes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IMPORT_C int tbuf8towchar </td>
<td>(</td>
<td class="paramtype">TDes8 & </td>
<td class="paramname"> <em>aSrc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wchar_t * </td>
<td class="paramname"> <em>aDes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This Api converts the tbuf8 to a wide-character string. It is user responsibality to allocate a required size of wide-char object. Api may resulting in crash, if the destination object size is smaller than that of the source. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aSrc</em> </td><td>TDes8 object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aDes</em> </td><td>wide-character pointer, to which the resultant string will be copied. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>returns an integer value. </dd>
<dd>
Api returns -1 in case of any error. </dd></dl>
<p>Definition at line <a class="el" href="stringutils_8cpp_source.html#l00048">48</a> of file <a class="el" href="stringutils_8cpp_source.html">stringutils.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9e6c0fa268a62a4facea28cb5a83bfcb"></a><!-- doxytag: member="stringutils.h::tbufC16towchar" ref="a9e6c0fa268a62a4facea28cb5a83bfcb" args="(TDesC &aSrc, wchar_t *aDes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IMPORT_C void tbufC16towchar </td>
<td>(</td>
<td class="paramtype">TDesC & </td>
<td class="paramname"> <em>aSrc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wchar_t * </td>
<td class="paramname"> <em>aDes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This Api converts the tbuf16 to a wide-character string. It is user responsibality to allocate a required size of wide-char object. Api may resulting in crash, if the destination object size is smaller than that of the source. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aSrc</em> </td><td>TDes16 object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aDes</em> </td><td>wide-character pointer, to which the resultant string will be copied. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>none </dd></dl>
<p>Definition at line <a class="el" href="stringutils_8cpp_source.html#l00058">58</a> of file <a class="el" href="stringutils_8cpp_source.html">stringutils.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a06e4914590a9e3b316c972dd598e2024"></a><!-- doxytag: member="stringutils.h::tbufC8tochar" ref="a06e4914590a9e3b316c972dd598e2024" args="(TDesC8 &aSrc, char *aDes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IMPORT_C void tbufC8tochar </td>
<td>(</td>
<td class="paramtype">TDesC8 & </td>
<td class="paramname"> <em>aSrc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>aDes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This Api converts the tbufC8 to a character string. It is user responsibality to allocate a required size of wide-char object. Api may resulting in crash, if the destination object size is smaller than that of the source. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aSrc</em> </td><td>TDesC8 object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aDes</em> </td><td>character pointer, to which the resultant string will be copied. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>none </dd></dl>
<p>Definition at line <a class="el" href="stringutils_8cpp_source.html#l00066">66</a> of file <a class="el" href="stringutils_8cpp_source.html">stringutils.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a760b3acc819bce96dcc444b61e18985d"></a><!-- doxytag: member="stringutils.h::tbufC16tochar" ref="a760b3acc819bce96dcc444b61e18985d" args="(TDesC &aSrc, char *aDes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IMPORT_C int tbufC16tochar </td>
<td>(</td>
<td class="paramtype">TDesC & </td>
<td class="paramname"> <em>aSrc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>aDes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This Api converts the TBufC16 to a character string. It is user responsibality to allocate a required size of wide-char object. Api may resulting in crash, if the destination object size is smaller than that of the source. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aSrc</em> </td><td>TDesC object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aDes</em> </td><td>character pointer, to which the resultant string will be copied. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>returns an integer value. </dd>
<dd>
Api returns -1 in case of any error. </dd></dl>
<p>Definition at line <a class="el" href="stringutils_8cpp_source.html#l00074">74</a> of file <a class="el" href="stringutils_8cpp_source.html">stringutils.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a756faf258af3a7d145afdf8ad9032908"></a><!-- doxytag: member="stringutils.h::tbufC8towchar" ref="a756faf258af3a7d145afdf8ad9032908" args="(TDesC8 &aSrc, wchar_t *aDes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IMPORT_C int tbufC8towchar </td>
<td>(</td>
<td class="paramtype">TDesC8 & </td>
<td class="paramname"> <em>aSrc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wchar_t * </td>
<td class="paramname"> <em>aDes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This Api converts the TBufC8 to a wide-character string. It is user responsibality to allocate a required size of wide-char object. Api may resulting in crash, if the destination object size is smaller than that of the source. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aSrc</em> </td><td>TDesC8 object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aDes</em> </td><td>wide-character pointer, to which the resultant string will be copied. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>returns an integer value. </dd>
<dd>
Api returns -1 in case of any error. </dd></dl>
<p>Definition at line <a class="el" href="stringutils_8cpp_source.html#l00086">86</a> of file <a class="el" href="stringutils_8cpp_source.html">stringutils.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af57eac18681e12a2a2579a46f900c531"></a><!-- doxytag: member="stringutils.h::wchartotbuf16" ref="af57eac18681e12a2a2579a46f900c531" args="(const wchar_t *aSrc, TDes16 &aDes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IMPORT_C void wchartotbuf16 </td>
<td>(</td>
<td class="paramtype">const wchar_t * </td>
<td class="paramname"> <em>aSrc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TDes16 & </td>
<td class="paramname"> <em>aDes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Functions to convert C character and Wide-Character strings to SYMBIAN descriptors This Api converts the wide-char to a TBuf16. It is user responsibality to allocate a required size of TBuf16 object. Api may resulting in crash, if the destination object size is smaller than that of the source. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aSrc</em> </td><td>wide-character pointer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aDes</em> </td><td>TBuf16 object, to which the resultant string will be copied. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>none </dd></dl>
<p>Definition at line <a class="el" href="stringutils_8cpp_source.html#l00096">96</a> of file <a class="el" href="stringutils_8cpp_source.html">stringutils.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa5c2923704de78bc06da21acae819bc7"></a><!-- doxytag: member="stringutils.h::chartotbuf16" ref="aa5c2923704de78bc06da21acae819bc7" args="(const char *aSrc, TDes16 &aDes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IMPORT_C int chartotbuf16 </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>aSrc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TDes16 & </td>
<td class="paramname"> <em>aDes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This Api converts the char to a TBuf16. It is user responsibality to allocate a required size of TBuf16 object. Api may resulting in crash, if the destination object size is smaller than that of the source. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aSrc</em> </td><td>character pointer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aDes</em> </td><td>TBuf16 object, to which the resultant string will be copied. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>returns an integer value. </dd>
<dd>
Api returns -1 in case of any error. </dd></dl>
<p>Definition at line <a class="el" href="stringutils_8cpp_source.html#l00101">101</a> of file <a class="el" href="stringutils_8cpp_source.html">stringutils.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a74d0bc81ee2e712248f5c18b23411100"></a><!-- doxytag: member="stringutils.h::wchartotbuf8" ref="a74d0bc81ee2e712248f5c18b23411100" args="(const wchar_t *aSrc, TDes8 &aDes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IMPORT_C int wchartotbuf8 </td>
<td>(</td>
<td class="paramtype">const wchar_t * </td>
<td class="paramname"> <em>aSrc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TDes8 & </td>
<td class="paramname"> <em>aDes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This Api converts the wide-char string to a TBuf8. It is user responsibality to allocate a required size of TBuf8 object. Api may resulting in crash, if the destination object size is smaller than that of the source. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aSrc</em> </td><td>wide-character pointer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aDes</em> </td><td>TBuf8 object, to which the resultant string will be copied. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>returns an integer value. </dd>
<dd>
Api returns -1 in case of any error. </dd></dl>
<p>Definition at line <a class="el" href="stringutils_8cpp_source.html#l00115">115</a> of file <a class="el" href="stringutils_8cpp_source.html">stringutils.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a328900ebbbca3b494bd356d272433892"></a><!-- doxytag: member="stringutils.h::wchartohbufc16" ref="a328900ebbbca3b494bd356d272433892" args="(const wchar_t *aSrc, HBufC16 &aDes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IMPORT_C void wchartohbufc16 </td>
<td>(</td>
<td class="paramtype">const wchar_t * </td>
<td class="paramname"> <em>aSrc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">HBufC16 & </td>
<td class="paramname"> <em>aDes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This Api converts the wide-char to a HBufC16. It is user responsibality to allocate a required size of HBufC16 object. Api may resulting in crash, if the destination object size is smaller than that of the source. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aSrc</em> </td><td>wide-character pointer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aDes</em> </td><td>HBufC16 object, to which the resultant string will be copied. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>none </dd></dl>
<p>Definition at line <a class="el" href="stringutils_8cpp_source.html#l00134">134</a> of file <a class="el" href="stringutils_8cpp_source.html">stringutils.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aecde687b6096958e753361b93a22ba23"></a><!-- doxytag: member="stringutils.h::chartohbufc16" ref="aecde687b6096958e753361b93a22ba23" args="(const char *aSrc, HBufC16 &aDes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IMPORT_C int chartohbufc16 </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>aSrc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">HBufC16 & </td>
<td class="paramname"> <em>aDes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This Api converts the char to a HBufC16. It is user responsibality to allocate a required size of HBufC16 object. Api may resulting in crash, if the destination object size is smaller than that of the source. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aSrc</em> </td><td>character pointer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aDes</em> </td><td>HBufC16 object, to which the resultant string will be copied. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>returns an integer value. </dd>
<dd>
Api returns -1 in case of any error. </dd></dl>
<p>Definition at line <a class="el" href="stringutils_8cpp_source.html#l00139">139</a> of file <a class="el" href="stringutils_8cpp_source.html">stringutils.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab28f816757c669da455d3112bc013a75"></a><!-- doxytag: member="stringutils.h::wchartohbufc8" ref="ab28f816757c669da455d3112bc013a75" args="(const wchar_t *aSrc, HBufC8 &aDes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IMPORT_C int wchartohbufc8 </td>
<td>(</td>
<td class="paramtype">const wchar_t * </td>
<td class="paramname"> <em>aSrc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">HBufC8 & </td>
<td class="paramname"> <em>aDes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This Api converts the wide-char to a HBufC8. It is user responsibality to allocate a required size of HBufC8 object. Api may resulting in crash, if the destination object size is smaller than that of the source. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aSrc</em> </td><td>wide-character pointer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aDes</em> </td><td>HBufC8 object, to which the resultant string will be copied. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>returns an integer value. </dd>
<dd>
Api returns -1 in case of any error. </dd></dl>
<p>Definition at line <a class="el" href="stringutils_8cpp_source.html#l00158">158</a> of file <a class="el" href="stringutils_8cpp_source.html">stringutils.cpp</a>.</p>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>