|
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
2 <html xmlns="http://www.w3.org/1999/xhtml"> |
|
3 <head> |
|
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
|
5 <title>TB9.2 Example Applications: examples/PIPS/OpenCStringUtilitiesEx/library/inc/stringutils.h File Reference</title> |
|
6 <link href="tabs.css" rel="stylesheet" type="text/css"/> |
|
7 <link href="doxygen.css" rel="stylesheet" type="text/css"/> |
|
8 </head> |
|
9 <body> |
|
10 <!-- Generated by Doxygen 1.6.2 --> |
|
11 <div class="contents"> |
|
12 <h1>examples/PIPS/OpenCStringUtilitiesEx/library/inc/stringutils.h File Reference</h1> |
|
13 <p><a href="stringutils_8h_source.html">Go to the source code of this file.</a></p> |
|
14 <table border="0" cellpadding="0" cellspacing="0"> |
|
15 <tr><td colspan="2"><h2>Defines</h2></td></tr> |
|
16 <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> |
|
17 <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> |
|
18 <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> |
|
19 <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> |
|
20 <tr><td colspan="2"><h2>Functions</h2></td></tr> |
|
21 <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> |
|
22 <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> |
|
23 <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> |
|
24 <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> |
|
25 <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> |
|
26 <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> |
|
27 <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> |
|
28 <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> |
|
29 <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> |
|
30 <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> |
|
31 <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> |
|
32 <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)" --> |
|
33 IMPORT_C void </td><td class="memItemRight" valign="bottom"><b>chartotbuf8</b> (const char *aSrc, TDes8 &aDes)</td></tr> |
|
34 <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> |
|
35 <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> |
|
36 <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> |
|
37 <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)" --> |
|
38 IMPORT_C void </td><td class="memItemRight" valign="bottom"><b>chartohbufc8</b> (const char *aSrc, HBufC8 &aDes)</td></tr> |
|
39 </table> |
|
40 <hr/><a name="_details"></a><h2>Detailed Description</h2> |
|
41 <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> |
|
42 |
|
43 <p>Definition in file <a class="el" href="stringutils_8h_source.html">stringutils.h</a>.</p> |
|
44 <hr/><h2>Define Documentation</h2> |
|
45 <a class="anchor" id="a0fcdfc9f202050b7e5a2cd54da14d2fe"></a><!-- doxytag: member="stringutils.h::hbufC16towchar" ref="a0fcdfc9f202050b7e5a2cd54da14d2fe" args="" --> |
|
46 <div class="memitem"> |
|
47 <div class="memproto"> |
|
48 <table class="memname"> |
|
49 <tr> |
|
50 <td class="memname">#define hbufC16towchar tbufC16towchar</td> |
|
51 </tr> |
|
52 </table> |
|
53 </div> |
|
54 <div class="memdoc"> |
|
55 <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> |
|
56 |
|
57 <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> |
|
58 |
|
59 </div> |
|
60 </div> |
|
61 <a class="anchor" id="ac8c22cd9144639f951b2193e373f0d2f"></a><!-- doxytag: member="stringutils.h::hbufC16tochar" ref="ac8c22cd9144639f951b2193e373f0d2f" args="" --> |
|
62 <div class="memitem"> |
|
63 <div class="memproto"> |
|
64 <table class="memname"> |
|
65 <tr> |
|
66 <td class="memname">#define hbufC16tochar tbufC16tochar</td> |
|
67 </tr> |
|
68 </table> |
|
69 </div> |
|
70 <div class="memdoc"> |
|
71 <p>Alias to the function tbufC16tochar </p> |
|
72 |
|
73 <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> |
|
74 |
|
75 </div> |
|
76 </div> |
|
77 <a class="anchor" id="a88565a9ed99585f8391862e7f5b4d17c"></a><!-- doxytag: member="stringutils.h::hbufC8towchar" ref="a88565a9ed99585f8391862e7f5b4d17c" args="" --> |
|
78 <div class="memitem"> |
|
79 <div class="memproto"> |
|
80 <table class="memname"> |
|
81 <tr> |
|
82 <td class="memname">#define hbufC8towchar tbufC8towchar</td> |
|
83 </tr> |
|
84 </table> |
|
85 </div> |
|
86 <div class="memdoc"> |
|
87 <p>Alias to the function tbufC8towchar </p> |
|
88 |
|
89 <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> |
|
90 |
|
91 </div> |
|
92 </div> |
|
93 <a class="anchor" id="a6319f08fa6eea77d034e46eaa60584b0"></a><!-- doxytag: member="stringutils.h::hbufC8tochar" ref="a6319f08fa6eea77d034e46eaa60584b0" args="" --> |
|
94 <div class="memitem"> |
|
95 <div class="memproto"> |
|
96 <table class="memname"> |
|
97 <tr> |
|
98 <td class="memname">#define hbufC8tochar tbufC8tochar</td> |
|
99 </tr> |
|
100 </table> |
|
101 </div> |
|
102 <div class="memdoc"> |
|
103 <p>Alias to the function tbufC8tochar </p> |
|
104 |
|
105 <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> |
|
106 |
|
107 </div> |
|
108 </div> |
|
109 <hr/><h2>Function Documentation</h2> |
|
110 <a class="anchor" id="a9d3907ae46af2842f427b5c58fe6ac60"></a><!-- doxytag: member="stringutils.h::tbuf16towchar" ref="a9d3907ae46af2842f427b5c58fe6ac60" args="(TDes &aArg)" --> |
|
111 <div class="memitem"> |
|
112 <div class="memproto"> |
|
113 <table class="memname"> |
|
114 <tr> |
|
115 <td class="memname">IMPORT_C wchar_t* tbuf16towchar </td> |
|
116 <td>(</td> |
|
117 <td class="paramtype">TDes & </td> |
|
118 <td class="paramname"> <em>aArg</em></td> |
|
119 <td> ) </td> |
|
120 <td></td> |
|
121 </tr> |
|
122 </table> |
|
123 </div> |
|
124 <div class="memdoc"> |
|
125 <p>Functions to convert SYMBIAN descriptors to C character and Wide-Character strings This Api converts the tbuf16 to a wide-character string </p> |
|
126 <dl><dt><b>Parameters:</b></dt><dd> |
|
127 <table border="0" cellspacing="2" cellpadding="0"> |
|
128 <tr><td valign="top"></td><td valign="top"><em>aArg</em> </td><td>TDes object </td></tr> |
|
129 </table> |
|
130 </dd> |
|
131 </dl> |
|
132 <dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to a wide-character string </dd></dl> |
|
133 |
|
134 <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> |
|
135 |
|
136 </div> |
|
137 </div> |
|
138 <a class="anchor" id="a92e6d0f669d9f15f18c3789ddf5ca779"></a><!-- doxytag: member="stringutils.h::tbuf8tochar" ref="a92e6d0f669d9f15f18c3789ddf5ca779" args="(TDes8 &aArg)" --> |
|
139 <div class="memitem"> |
|
140 <div class="memproto"> |
|
141 <table class="memname"> |
|
142 <tr> |
|
143 <td class="memname">IMPORT_C char* tbuf8tochar </td> |
|
144 <td>(</td> |
|
145 <td class="paramtype">TDes8 & </td> |
|
146 <td class="paramname"> <em>aArg</em></td> |
|
147 <td> ) </td> |
|
148 <td></td> |
|
149 </tr> |
|
150 </table> |
|
151 </div> |
|
152 <div class="memdoc"> |
|
153 <p>This Api converts the tbuf8 to a character string </p> |
|
154 <dl><dt><b>Parameters:</b></dt><dd> |
|
155 <table border="0" cellspacing="2" cellpadding="0"> |
|
156 <tr><td valign="top"></td><td valign="top"><em>aArg</em> </td><td>TDes8 object </td></tr> |
|
157 </table> |
|
158 </dd> |
|
159 </dl> |
|
160 <dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to a character string </dd></dl> |
|
161 |
|
162 <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> |
|
163 |
|
164 </div> |
|
165 </div> |
|
166 <a class="anchor" id="a8d9e370a0c317212eb7193988b2702cf"></a><!-- doxytag: member="stringutils.h::tbuf16tochar" ref="a8d9e370a0c317212eb7193988b2702cf" args="(TDes &aSrc, char *aDes)" --> |
|
167 <div class="memitem"> |
|
168 <div class="memproto"> |
|
169 <table class="memname"> |
|
170 <tr> |
|
171 <td class="memname">IMPORT_C int tbuf16tochar </td> |
|
172 <td>(</td> |
|
173 <td class="paramtype">TDes & </td> |
|
174 <td class="paramname"> <em>aSrc</em>, </td> |
|
175 </tr> |
|
176 <tr> |
|
177 <td class="paramkey"></td> |
|
178 <td></td> |
|
179 <td class="paramtype">char * </td> |
|
180 <td class="paramname"> <em>aDes</em></td><td> </td> |
|
181 </tr> |
|
182 <tr> |
|
183 <td></td> |
|
184 <td>)</td> |
|
185 <td></td><td></td><td></td> |
|
186 </tr> |
|
187 </table> |
|
188 </div> |
|
189 <div class="memdoc"> |
|
190 <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> |
|
191 <dl><dt><b>Parameters:</b></dt><dd> |
|
192 <table border="0" cellspacing="2" cellpadding="0"> |
|
193 <tr><td valign="top"></td><td valign="top"><em>aSrc</em> </td><td>TDes16 object </td></tr> |
|
194 <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> |
|
195 </table> |
|
196 </dd> |
|
197 </dl> |
|
198 <dl class="return"><dt><b>Returns:</b></dt><dd>returns an integer value. </dd> |
|
199 <dd> |
|
200 Api returns -1 in case of any error. </dd></dl> |
|
201 |
|
202 <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> |
|
203 |
|
204 </div> |
|
205 </div> |
|
206 <a class="anchor" id="ac6ce874e6902d0d6f6142e6660866fcc"></a><!-- doxytag: member="stringutils.h::tbuf8towchar" ref="ac6ce874e6902d0d6f6142e6660866fcc" args="(TDes8 &aSrc, wchar_t *aDes)" --> |
|
207 <div class="memitem"> |
|
208 <div class="memproto"> |
|
209 <table class="memname"> |
|
210 <tr> |
|
211 <td class="memname">IMPORT_C int tbuf8towchar </td> |
|
212 <td>(</td> |
|
213 <td class="paramtype">TDes8 & </td> |
|
214 <td class="paramname"> <em>aSrc</em>, </td> |
|
215 </tr> |
|
216 <tr> |
|
217 <td class="paramkey"></td> |
|
218 <td></td> |
|
219 <td class="paramtype">wchar_t * </td> |
|
220 <td class="paramname"> <em>aDes</em></td><td> </td> |
|
221 </tr> |
|
222 <tr> |
|
223 <td></td> |
|
224 <td>)</td> |
|
225 <td></td><td></td><td></td> |
|
226 </tr> |
|
227 </table> |
|
228 </div> |
|
229 <div class="memdoc"> |
|
230 <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> |
|
231 <dl><dt><b>Parameters:</b></dt><dd> |
|
232 <table border="0" cellspacing="2" cellpadding="0"> |
|
233 <tr><td valign="top"></td><td valign="top"><em>aSrc</em> </td><td>TDes8 object </td></tr> |
|
234 <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> |
|
235 </table> |
|
236 </dd> |
|
237 </dl> |
|
238 <dl class="return"><dt><b>Returns:</b></dt><dd>returns an integer value. </dd> |
|
239 <dd> |
|
240 Api returns -1 in case of any error. </dd></dl> |
|
241 |
|
242 <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> |
|
243 |
|
244 </div> |
|
245 </div> |
|
246 <a class="anchor" id="a9e6c0fa268a62a4facea28cb5a83bfcb"></a><!-- doxytag: member="stringutils.h::tbufC16towchar" ref="a9e6c0fa268a62a4facea28cb5a83bfcb" args="(TDesC &aSrc, wchar_t *aDes)" --> |
|
247 <div class="memitem"> |
|
248 <div class="memproto"> |
|
249 <table class="memname"> |
|
250 <tr> |
|
251 <td class="memname">IMPORT_C void tbufC16towchar </td> |
|
252 <td>(</td> |
|
253 <td class="paramtype">TDesC & </td> |
|
254 <td class="paramname"> <em>aSrc</em>, </td> |
|
255 </tr> |
|
256 <tr> |
|
257 <td class="paramkey"></td> |
|
258 <td></td> |
|
259 <td class="paramtype">wchar_t * </td> |
|
260 <td class="paramname"> <em>aDes</em></td><td> </td> |
|
261 </tr> |
|
262 <tr> |
|
263 <td></td> |
|
264 <td>)</td> |
|
265 <td></td><td></td><td></td> |
|
266 </tr> |
|
267 </table> |
|
268 </div> |
|
269 <div class="memdoc"> |
|
270 <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> |
|
271 <dl><dt><b>Parameters:</b></dt><dd> |
|
272 <table border="0" cellspacing="2" cellpadding="0"> |
|
273 <tr><td valign="top"></td><td valign="top"><em>aSrc</em> </td><td>TDes16 object </td></tr> |
|
274 <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> |
|
275 </table> |
|
276 </dd> |
|
277 </dl> |
|
278 <dl class="return"><dt><b>Returns:</b></dt><dd>none </dd></dl> |
|
279 |
|
280 <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> |
|
281 |
|
282 </div> |
|
283 </div> |
|
284 <a class="anchor" id="a06e4914590a9e3b316c972dd598e2024"></a><!-- doxytag: member="stringutils.h::tbufC8tochar" ref="a06e4914590a9e3b316c972dd598e2024" args="(TDesC8 &aSrc, char *aDes)" --> |
|
285 <div class="memitem"> |
|
286 <div class="memproto"> |
|
287 <table class="memname"> |
|
288 <tr> |
|
289 <td class="memname">IMPORT_C void tbufC8tochar </td> |
|
290 <td>(</td> |
|
291 <td class="paramtype">TDesC8 & </td> |
|
292 <td class="paramname"> <em>aSrc</em>, </td> |
|
293 </tr> |
|
294 <tr> |
|
295 <td class="paramkey"></td> |
|
296 <td></td> |
|
297 <td class="paramtype">char * </td> |
|
298 <td class="paramname"> <em>aDes</em></td><td> </td> |
|
299 </tr> |
|
300 <tr> |
|
301 <td></td> |
|
302 <td>)</td> |
|
303 <td></td><td></td><td></td> |
|
304 </tr> |
|
305 </table> |
|
306 </div> |
|
307 <div class="memdoc"> |
|
308 <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> |
|
309 <dl><dt><b>Parameters:</b></dt><dd> |
|
310 <table border="0" cellspacing="2" cellpadding="0"> |
|
311 <tr><td valign="top"></td><td valign="top"><em>aSrc</em> </td><td>TDesC8 object </td></tr> |
|
312 <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> |
|
313 </table> |
|
314 </dd> |
|
315 </dl> |
|
316 <dl class="return"><dt><b>Returns:</b></dt><dd>none </dd></dl> |
|
317 |
|
318 <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> |
|
319 |
|
320 </div> |
|
321 </div> |
|
322 <a class="anchor" id="a760b3acc819bce96dcc444b61e18985d"></a><!-- doxytag: member="stringutils.h::tbufC16tochar" ref="a760b3acc819bce96dcc444b61e18985d" args="(TDesC &aSrc, char *aDes)" --> |
|
323 <div class="memitem"> |
|
324 <div class="memproto"> |
|
325 <table class="memname"> |
|
326 <tr> |
|
327 <td class="memname">IMPORT_C int tbufC16tochar </td> |
|
328 <td>(</td> |
|
329 <td class="paramtype">TDesC & </td> |
|
330 <td class="paramname"> <em>aSrc</em>, </td> |
|
331 </tr> |
|
332 <tr> |
|
333 <td class="paramkey"></td> |
|
334 <td></td> |
|
335 <td class="paramtype">char * </td> |
|
336 <td class="paramname"> <em>aDes</em></td><td> </td> |
|
337 </tr> |
|
338 <tr> |
|
339 <td></td> |
|
340 <td>)</td> |
|
341 <td></td><td></td><td></td> |
|
342 </tr> |
|
343 </table> |
|
344 </div> |
|
345 <div class="memdoc"> |
|
346 <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> |
|
347 <dl><dt><b>Parameters:</b></dt><dd> |
|
348 <table border="0" cellspacing="2" cellpadding="0"> |
|
349 <tr><td valign="top"></td><td valign="top"><em>aSrc</em> </td><td>TDesC object </td></tr> |
|
350 <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> |
|
351 </table> |
|
352 </dd> |
|
353 </dl> |
|
354 <dl class="return"><dt><b>Returns:</b></dt><dd>returns an integer value. </dd> |
|
355 <dd> |
|
356 Api returns -1 in case of any error. </dd></dl> |
|
357 |
|
358 <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> |
|
359 |
|
360 </div> |
|
361 </div> |
|
362 <a class="anchor" id="a756faf258af3a7d145afdf8ad9032908"></a><!-- doxytag: member="stringutils.h::tbufC8towchar" ref="a756faf258af3a7d145afdf8ad9032908" args="(TDesC8 &aSrc, wchar_t *aDes)" --> |
|
363 <div class="memitem"> |
|
364 <div class="memproto"> |
|
365 <table class="memname"> |
|
366 <tr> |
|
367 <td class="memname">IMPORT_C int tbufC8towchar </td> |
|
368 <td>(</td> |
|
369 <td class="paramtype">TDesC8 & </td> |
|
370 <td class="paramname"> <em>aSrc</em>, </td> |
|
371 </tr> |
|
372 <tr> |
|
373 <td class="paramkey"></td> |
|
374 <td></td> |
|
375 <td class="paramtype">wchar_t * </td> |
|
376 <td class="paramname"> <em>aDes</em></td><td> </td> |
|
377 </tr> |
|
378 <tr> |
|
379 <td></td> |
|
380 <td>)</td> |
|
381 <td></td><td></td><td></td> |
|
382 </tr> |
|
383 </table> |
|
384 </div> |
|
385 <div class="memdoc"> |
|
386 <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> |
|
387 <dl><dt><b>Parameters:</b></dt><dd> |
|
388 <table border="0" cellspacing="2" cellpadding="0"> |
|
389 <tr><td valign="top"></td><td valign="top"><em>aSrc</em> </td><td>TDesC8 object </td></tr> |
|
390 <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> |
|
391 </table> |
|
392 </dd> |
|
393 </dl> |
|
394 <dl class="return"><dt><b>Returns:</b></dt><dd>returns an integer value. </dd> |
|
395 <dd> |
|
396 Api returns -1 in case of any error. </dd></dl> |
|
397 |
|
398 <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> |
|
399 |
|
400 </div> |
|
401 </div> |
|
402 <a class="anchor" id="af57eac18681e12a2a2579a46f900c531"></a><!-- doxytag: member="stringutils.h::wchartotbuf16" ref="af57eac18681e12a2a2579a46f900c531" args="(const wchar_t *aSrc, TDes16 &aDes)" --> |
|
403 <div class="memitem"> |
|
404 <div class="memproto"> |
|
405 <table class="memname"> |
|
406 <tr> |
|
407 <td class="memname">IMPORT_C void wchartotbuf16 </td> |
|
408 <td>(</td> |
|
409 <td class="paramtype">const wchar_t * </td> |
|
410 <td class="paramname"> <em>aSrc</em>, </td> |
|
411 </tr> |
|
412 <tr> |
|
413 <td class="paramkey"></td> |
|
414 <td></td> |
|
415 <td class="paramtype">TDes16 & </td> |
|
416 <td class="paramname"> <em>aDes</em></td><td> </td> |
|
417 </tr> |
|
418 <tr> |
|
419 <td></td> |
|
420 <td>)</td> |
|
421 <td></td><td></td><td></td> |
|
422 </tr> |
|
423 </table> |
|
424 </div> |
|
425 <div class="memdoc"> |
|
426 <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> |
|
427 <dl><dt><b>Parameters:</b></dt><dd> |
|
428 <table border="0" cellspacing="2" cellpadding="0"> |
|
429 <tr><td valign="top"></td><td valign="top"><em>aSrc</em> </td><td>wide-character pointer. </td></tr> |
|
430 <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> |
|
431 </table> |
|
432 </dd> |
|
433 </dl> |
|
434 <dl class="return"><dt><b>Returns:</b></dt><dd>none </dd></dl> |
|
435 |
|
436 <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> |
|
437 |
|
438 </div> |
|
439 </div> |
|
440 <a class="anchor" id="aa5c2923704de78bc06da21acae819bc7"></a><!-- doxytag: member="stringutils.h::chartotbuf16" ref="aa5c2923704de78bc06da21acae819bc7" args="(const char *aSrc, TDes16 &aDes)" --> |
|
441 <div class="memitem"> |
|
442 <div class="memproto"> |
|
443 <table class="memname"> |
|
444 <tr> |
|
445 <td class="memname">IMPORT_C int chartotbuf16 </td> |
|
446 <td>(</td> |
|
447 <td class="paramtype">const char * </td> |
|
448 <td class="paramname"> <em>aSrc</em>, </td> |
|
449 </tr> |
|
450 <tr> |
|
451 <td class="paramkey"></td> |
|
452 <td></td> |
|
453 <td class="paramtype">TDes16 & </td> |
|
454 <td class="paramname"> <em>aDes</em></td><td> </td> |
|
455 </tr> |
|
456 <tr> |
|
457 <td></td> |
|
458 <td>)</td> |
|
459 <td></td><td></td><td></td> |
|
460 </tr> |
|
461 </table> |
|
462 </div> |
|
463 <div class="memdoc"> |
|
464 <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> |
|
465 <dl><dt><b>Parameters:</b></dt><dd> |
|
466 <table border="0" cellspacing="2" cellpadding="0"> |
|
467 <tr><td valign="top"></td><td valign="top"><em>aSrc</em> </td><td>character pointer. </td></tr> |
|
468 <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> |
|
469 </table> |
|
470 </dd> |
|
471 </dl> |
|
472 <dl class="return"><dt><b>Returns:</b></dt><dd>returns an integer value. </dd> |
|
473 <dd> |
|
474 Api returns -1 in case of any error. </dd></dl> |
|
475 |
|
476 <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> |
|
477 |
|
478 </div> |
|
479 </div> |
|
480 <a class="anchor" id="a74d0bc81ee2e712248f5c18b23411100"></a><!-- doxytag: member="stringutils.h::wchartotbuf8" ref="a74d0bc81ee2e712248f5c18b23411100" args="(const wchar_t *aSrc, TDes8 &aDes)" --> |
|
481 <div class="memitem"> |
|
482 <div class="memproto"> |
|
483 <table class="memname"> |
|
484 <tr> |
|
485 <td class="memname">IMPORT_C int wchartotbuf8 </td> |
|
486 <td>(</td> |
|
487 <td class="paramtype">const wchar_t * </td> |
|
488 <td class="paramname"> <em>aSrc</em>, </td> |
|
489 </tr> |
|
490 <tr> |
|
491 <td class="paramkey"></td> |
|
492 <td></td> |
|
493 <td class="paramtype">TDes8 & </td> |
|
494 <td class="paramname"> <em>aDes</em></td><td> </td> |
|
495 </tr> |
|
496 <tr> |
|
497 <td></td> |
|
498 <td>)</td> |
|
499 <td></td><td></td><td></td> |
|
500 </tr> |
|
501 </table> |
|
502 </div> |
|
503 <div class="memdoc"> |
|
504 <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> |
|
505 <dl><dt><b>Parameters:</b></dt><dd> |
|
506 <table border="0" cellspacing="2" cellpadding="0"> |
|
507 <tr><td valign="top"></td><td valign="top"><em>aSrc</em> </td><td>wide-character pointer. </td></tr> |
|
508 <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> |
|
509 </table> |
|
510 </dd> |
|
511 </dl> |
|
512 <dl class="return"><dt><b>Returns:</b></dt><dd>returns an integer value. </dd> |
|
513 <dd> |
|
514 Api returns -1 in case of any error. </dd></dl> |
|
515 |
|
516 <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> |
|
517 |
|
518 </div> |
|
519 </div> |
|
520 <a class="anchor" id="a328900ebbbca3b494bd356d272433892"></a><!-- doxytag: member="stringutils.h::wchartohbufc16" ref="a328900ebbbca3b494bd356d272433892" args="(const wchar_t *aSrc, HBufC16 &aDes)" --> |
|
521 <div class="memitem"> |
|
522 <div class="memproto"> |
|
523 <table class="memname"> |
|
524 <tr> |
|
525 <td class="memname">IMPORT_C void wchartohbufc16 </td> |
|
526 <td>(</td> |
|
527 <td class="paramtype">const wchar_t * </td> |
|
528 <td class="paramname"> <em>aSrc</em>, </td> |
|
529 </tr> |
|
530 <tr> |
|
531 <td class="paramkey"></td> |
|
532 <td></td> |
|
533 <td class="paramtype">HBufC16 & </td> |
|
534 <td class="paramname"> <em>aDes</em></td><td> </td> |
|
535 </tr> |
|
536 <tr> |
|
537 <td></td> |
|
538 <td>)</td> |
|
539 <td></td><td></td><td></td> |
|
540 </tr> |
|
541 </table> |
|
542 </div> |
|
543 <div class="memdoc"> |
|
544 <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> |
|
545 <dl><dt><b>Parameters:</b></dt><dd> |
|
546 <table border="0" cellspacing="2" cellpadding="0"> |
|
547 <tr><td valign="top"></td><td valign="top"><em>aSrc</em> </td><td>wide-character pointer. </td></tr> |
|
548 <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> |
|
549 </table> |
|
550 </dd> |
|
551 </dl> |
|
552 <dl class="return"><dt><b>Returns:</b></dt><dd>none </dd></dl> |
|
553 |
|
554 <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> |
|
555 |
|
556 </div> |
|
557 </div> |
|
558 <a class="anchor" id="aecde687b6096958e753361b93a22ba23"></a><!-- doxytag: member="stringutils.h::chartohbufc16" ref="aecde687b6096958e753361b93a22ba23" args="(const char *aSrc, HBufC16 &aDes)" --> |
|
559 <div class="memitem"> |
|
560 <div class="memproto"> |
|
561 <table class="memname"> |
|
562 <tr> |
|
563 <td class="memname">IMPORT_C int chartohbufc16 </td> |
|
564 <td>(</td> |
|
565 <td class="paramtype">const char * </td> |
|
566 <td class="paramname"> <em>aSrc</em>, </td> |
|
567 </tr> |
|
568 <tr> |
|
569 <td class="paramkey"></td> |
|
570 <td></td> |
|
571 <td class="paramtype">HBufC16 & </td> |
|
572 <td class="paramname"> <em>aDes</em></td><td> </td> |
|
573 </tr> |
|
574 <tr> |
|
575 <td></td> |
|
576 <td>)</td> |
|
577 <td></td><td></td><td></td> |
|
578 </tr> |
|
579 </table> |
|
580 </div> |
|
581 <div class="memdoc"> |
|
582 <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> |
|
583 <dl><dt><b>Parameters:</b></dt><dd> |
|
584 <table border="0" cellspacing="2" cellpadding="0"> |
|
585 <tr><td valign="top"></td><td valign="top"><em>aSrc</em> </td><td>character pointer. </td></tr> |
|
586 <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> |
|
587 </table> |
|
588 </dd> |
|
589 </dl> |
|
590 <dl class="return"><dt><b>Returns:</b></dt><dd>returns an integer value. </dd> |
|
591 <dd> |
|
592 Api returns -1 in case of any error. </dd></dl> |
|
593 |
|
594 <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> |
|
595 |
|
596 </div> |
|
597 </div> |
|
598 <a class="anchor" id="ab28f816757c669da455d3112bc013a75"></a><!-- doxytag: member="stringutils.h::wchartohbufc8" ref="ab28f816757c669da455d3112bc013a75" args="(const wchar_t *aSrc, HBufC8 &aDes)" --> |
|
599 <div class="memitem"> |
|
600 <div class="memproto"> |
|
601 <table class="memname"> |
|
602 <tr> |
|
603 <td class="memname">IMPORT_C int wchartohbufc8 </td> |
|
604 <td>(</td> |
|
605 <td class="paramtype">const wchar_t * </td> |
|
606 <td class="paramname"> <em>aSrc</em>, </td> |
|
607 </tr> |
|
608 <tr> |
|
609 <td class="paramkey"></td> |
|
610 <td></td> |
|
611 <td class="paramtype">HBufC8 & </td> |
|
612 <td class="paramname"> <em>aDes</em></td><td> </td> |
|
613 </tr> |
|
614 <tr> |
|
615 <td></td> |
|
616 <td>)</td> |
|
617 <td></td><td></td><td></td> |
|
618 </tr> |
|
619 </table> |
|
620 </div> |
|
621 <div class="memdoc"> |
|
622 <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> |
|
623 <dl><dt><b>Parameters:</b></dt><dd> |
|
624 <table border="0" cellspacing="2" cellpadding="0"> |
|
625 <tr><td valign="top"></td><td valign="top"><em>aSrc</em> </td><td>wide-character pointer. </td></tr> |
|
626 <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> |
|
627 </table> |
|
628 </dd> |
|
629 </dl> |
|
630 <dl class="return"><dt><b>Returns:</b></dt><dd>returns an integer value. </dd> |
|
631 <dd> |
|
632 Api returns -1 in case of any error. </dd></dl> |
|
633 |
|
634 <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> |
|
635 |
|
636 </div> |
|
637 </div> |
|
638 </div> |
|
639 <hr size="1"/><address style="text-align: right;"><small>Generated by |
|
640 <a href="http://www.doxygen.org/index.html"> |
|
641 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address> |
|
642 </body> |
|
643 </html> |