1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 3<title>OSCL_String class Reference</title> 4<link href="doxygen.css" rel="stylesheet" type="text/css"> 5</head><body> 6<!-- Generated by Doxygen 1.2.18 --> 7<center> 8<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> 9<hr><h1>OSCL_String Class Reference<br> 10<small> 11[<a class="el" href="group__osclutil.html">OSCL Util</a>]</small> 12</h1><code>#include <<a class="el" href="oscl__string_8h-source.html">oscl_string.h</a>></code> 13<p> 14<p>Inheritance diagram for OSCL_String: 15<p><center><img src="classOSCL__String.png" usemap="#OSCL_String_map" border="0" alt=""></center> 16<map name="OSCL_String_map"> 17<area href="classHeapBase.html" alt="HeapBase" shape="rect" coords="327,56,535,80"> 18<area href="class__OsclHeapBase.html" alt="_OsclHeapBase" shape="rect" coords="327,0,535,24"> 19<area href="classOSCL__FastString.html" alt="OSCL_FastString" shape="rect" coords="0,168,208,192"> 20<area href="classOSCL__HeapString.html" alt="OSCL_HeapString< Alloc >" shape="rect" coords="218,168,426,192"> 21<area href="classOSCL__HeapStringA.html" alt="OSCL_HeapStringA" shape="rect" coords="436,168,644,192"> 22<area href="classOSCL__StackString.html" alt="OSCL_StackString< MaxBufSize >" shape="rect" coords="654,168,862,192"> 23</map> 24<table border=0 cellpadding=0 cellspacing=0> 25<tr><td></td></tr> 26<tr><td colspan=2><br><h2>Public Types</h2></td></tr> 27<tr><td nowrap align=right valign=top>typedef char </td><td valign=bottom><a class="el" href="classOSCL__String.html#s0">chartype</a></td></tr> 28<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> 29<tr><td nowrap align=right valign=top>virtual uint32 </td><td valign=bottom><a class="el" href="classOSCL__String.html#a0">get_size</a> () const=0</td></tr> 30<tr><td nowrap align=right valign=top>virtual uint32 </td><td valign=bottom><a class="el" href="classOSCL__String.html#a1">get_maxsize</a> () const=0</td></tr> 31<tr><td nowrap align=right valign=top>virtual const <a class="el" href="classOSCL__String.html#s0">chartype</a> * </td><td valign=bottom><a class="el" href="classOSCL__String.html#a2">get_cstr</a> () const=0</td></tr> 32<tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF bool </td><td valign=bottom><a class="el" href="classOSCL__String.html#a3">is_writable</a> () const</td></tr> 33<tr><td nowrap align=right valign=top>virtual <a class="el" href="classOSCL__String.html#s0">chartype</a> * </td><td valign=bottom><a class="el" href="classOSCL__String.html#a4">get_str</a> () const=0</td></tr> 34<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF OSCL_String & </td><td valign=bottom><a class="el" href="classOSCL__String.html#a5">operator=</a> (const OSCL_String &src)</td></tr> 35<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF OSCL_String & </td><td valign=bottom><a class="el" href="classOSCL__String.html#a6">operator=</a> (const <a class="el" href="classOSCL__String.html#s0">chartype</a> *cstr)</td></tr> 36<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF OSCL_String & </td><td valign=bottom><a class="el" href="classOSCL__String.html#a7">operator+=</a> (const OSCL_String &src)</td></tr> 37<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF OSCL_String & </td><td valign=bottom><a class="el" href="classOSCL__String.html#a8">operator+=</a> (const <a class="el" href="classOSCL__String.html#s0">chartype</a> *cstr)</td></tr> 38<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF OSCL_String & </td><td valign=bottom><a class="el" href="classOSCL__String.html#a9">operator+=</a> (const <a class="el" href="classOSCL__String.html#s0">chartype</a> c)</td></tr> 39<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF bool </td><td valign=bottom><a class="el" href="classOSCL__String.html#a10">operator==</a> (const OSCL_String &src) const</td></tr> 40<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF bool </td><td valign=bottom><a class="el" href="classOSCL__String.html#a11">operator!=</a> (const OSCL_String &src) const</td></tr> 41<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF bool </td><td valign=bottom><a class="el" href="classOSCL__String.html#a12">operator<</a> (const OSCL_String &src) const</td></tr> 42<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF bool </td><td valign=bottom><a class="el" href="classOSCL__String.html#a13">operator<=</a> (const OSCL_String &src) const</td></tr> 43<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF bool </td><td valign=bottom><a class="el" href="classOSCL__String.html#a14">operator></a> (const OSCL_String &src) const</td></tr> 44<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF bool </td><td valign=bottom><a class="el" href="classOSCL__String.html#a15">operator>=</a> (const OSCL_String &src) const</td></tr> 45<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF bool </td><td valign=bottom><a class="el" href="classOSCL__String.html#a16">operator==</a> (const <a class="el" href="classOSCL__String.html#s0">chartype</a> *cstr) const</td></tr> 46<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF <a class="el" href="classOSCL__String.html#s0">chartype</a> </td><td valign=bottom><a class="el" href="classOSCL__String.html#a17">operator[]</a> (uint32 index) const</td></tr> 47<tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF <a class="el" href="classOSCL__String.html#s0">chartype</a> </td><td valign=bottom><a class="el" href="classOSCL__String.html#a18">read</a> (uint32 index) const</td></tr> 48<tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF int8 </td><td valign=bottom><a class="el" href="classOSCL__String.html#a19">hash</a> () const</td></tr> 49<tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF void </td><td valign=bottom><a class="el" href="classOSCL__String.html#a20">write</a> (uint32 index, <a class="el" href="classOSCL__String.html#s0">chartype</a> c)</td></tr> 50<tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF void </td><td valign=bottom><a class="el" href="classOSCL__String.html#a21">write</a> (uint32 offset, uint32 length, const <a class="el" href="classOSCL__String.html#s0">chartype</a> *buf)</td></tr> 51<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> 52<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF </td><td valign=bottom><a class="el" href="classOSCL__String.html#b0">OSCL_String</a> ()</td></tr> 53<tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF </td><td valign=bottom><a class="el" href="classOSCL__String.html#b1">~OSCL_String</a> ()</td></tr> 54<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classOSCL__String.html#b2">set_rep</a> (const <a class="el" href="classOSCL__String.html#s0">chartype</a> *cstr)=0</td></tr> 55<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classOSCL__String.html#b3">append_rep</a> (const <a class="el" href="classOSCL__String.html#s0">chartype</a> *cstr)=0</td></tr> 56<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classOSCL__String.html#b4">set_rep</a> (const OSCL_String &src)=0</td></tr> 57<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classOSCL__String.html#b5">append_rep</a> (const OSCL_String &src)=0</td></tr> 58<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classOSCL__String.html#b6">set_len</a> (uint32 len)=0</td></tr> 59</table> 60<hr><a name="_details"></a><h2>Detailed Description</h2> 61A common base class for string classes with "char" character format 62<p> 63<hr><h2>Member Typedef Documentation</h2> 64<a name="s0" doxytag="OSCL_String::chartype"></a><p> 65<table width="100%" cellpadding="2" cellspacing="0" border="0"> 66 <tr> 67 <td class="md"> 68 <table cellpadding="0" cellspacing="0" border="0"> 69 <tr> 70 <td class="md" nowrap valign="top"> typedef char OSCL_String::chartype 71 </table> 72 </td> 73 </tr> 74</table> 75<table cellspacing=5 cellpadding=0 border=0> 76 <tr> 77 <td> 78 79 </td> 80 <td> 81 82<p> 83 84<p> 85Reimplemented in <a class="el" href="classOSCL__HeapString.html#s0">OSCL_HeapString< Alloc ></a>, <a class="el" href="classOSCL__HeapStringA.html#s0">OSCL_HeapStringA</a>, <a class="el" href="classOSCL__StackString.html#s0">OSCL_StackString< MaxBufSize ></a>, <a class="el" href="classOSCL__FastString.html#s0">OSCL_FastString</a>, and <a class="el" href="classOSCL__HeapString.html#s0">OSCL_HeapString< OsclMemAllocator ></a>. </td> 86 </tr> 87</table> 88<hr><h2>Constructor & Destructor Documentation</h2> 89<a name="b0" doxytag="OSCL_String::OSCL_String"></a><p> 90<table width="100%" cellpadding="2" cellspacing="0" border="0"> 91 <tr> 92 <td class="md"> 93 <table cellpadding="0" cellspacing="0" border="0"> 94 <tr> 95 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF OSCL_String::OSCL_String </td> 96 <td class="md" valign="top">( </td> 97 <td class="mdname1" valign="top" nowrap> </td> 98 <td class="md" valign="top">) </td> 99 <td class="md" nowrap><code> [protected]</code></td> 100 </tr> 101 102 </table> 103 </td> 104 </tr> 105</table> 106<table cellspacing=5 cellpadding=0 border=0> 107 <tr> 108 <td> 109 110 </td> 111 <td> 112 113<p> 114 </td> 115 </tr> 116</table> 117<a name="b1" doxytag="OSCL_String::~OSCL_String"></a><p> 118<table width="100%" cellpadding="2" cellspacing="0" border="0"> 119 <tr> 120 <td class="md"> 121 <table cellpadding="0" cellspacing="0" border="0"> 122 <tr> 123 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF OSCL_String::~OSCL_String </td> 124 <td class="md" valign="top">( </td> 125 <td class="mdname1" valign="top" nowrap> </td> 126 <td class="md" valign="top">) </td> 127 <td class="md" nowrap><code> [protected, virtual]</code></td> 128 </tr> 129 130 </table> 131 </td> 132 </tr> 133</table> 134<table cellspacing=5 cellpadding=0 border=0> 135 <tr> 136 <td> 137 138 </td> 139 <td> 140 141<p> 142 </td> 143 </tr> 144</table> 145<hr><h2>Member Function Documentation</h2> 146<a name="b5" doxytag="OSCL_String::append_rep"></a><p> 147<table width="100%" cellpadding="2" cellspacing="0" border="0"> 148 <tr> 149 <td class="md"> 150 <table cellpadding="0" cellspacing="0" border="0"> 151 <tr> 152 <td class="md" nowrap valign="top"> virtual void OSCL_String::append_rep </td> 153 <td class="md" valign="top">( </td> 154 <td class="md" nowrap valign="top">const OSCL_String & </td> 155 <td class="mdname1" valign="top" nowrap> <em>src</em> </td> 156 <td class="md" valign="top">) </td> 157 <td class="md" nowrap><code> [protected, pure virtual]</code></td> 158 </tr> 159 160 </table> 161 </td> 162 </tr> 163</table> 164<table cellspacing=5 cellpadding=0 border=0> 165 <tr> 166 <td> 167 168 </td> 169 <td> 170 171<p> 172Append the input string to the current string. The string may be truncated to fit the available storage. </td> 173 </tr> 174</table> 175<a name="b3" doxytag="OSCL_String::append_rep"></a><p> 176<table width="100%" cellpadding="2" cellspacing="0" border="0"> 177 <tr> 178 <td class="md"> 179 <table cellpadding="0" cellspacing="0" border="0"> 180 <tr> 181 <td class="md" nowrap valign="top"> virtual void OSCL_String::append_rep </td> 182 <td class="md" valign="top">( </td> 183 <td class="md" nowrap valign="top">const <a class="el" href="classOSCL__String.html#s0">chartype</a> * </td> 184 <td class="mdname1" valign="top" nowrap> <em>cstr</em> </td> 185 <td class="md" valign="top">) </td> 186 <td class="md" nowrap><code> [protected, pure virtual]</code></td> 187 </tr> 188 189 </table> 190 </td> 191 </tr> 192</table> 193<table cellspacing=5 cellpadding=0 border=0> 194 <tr> 195 <td> 196 197 </td> 198 <td> 199 200<p> 201Append the input null-terminated string to the current string. The string may be truncated to fit the available storage. </td> 202 </tr> 203</table> 204<a name="a2" doxytag="OSCL_String::get_cstr"></a><p> 205<table width="100%" cellpadding="2" cellspacing="0" border="0"> 206 <tr> 207 <td class="md"> 208 <table cellpadding="0" cellspacing="0" border="0"> 209 <tr> 210 <td class="md" nowrap valign="top"> virtual const <a class="el" href="classOSCL__String.html#s0">chartype</a>* OSCL_String::get_cstr </td> 211 <td class="md" valign="top">( </td> 212 <td class="mdname1" valign="top" nowrap> </td> 213 <td class="md" valign="top">) </td> 214 <td class="md" nowrap><code> [pure virtual]</code></td> 215 </tr> 216 217 </table> 218 </td> 219 </tr> 220</table> 221<table cellspacing=5 cellpadding=0 border=0> 222 <tr> 223 <td> 224 225 </td> 226 <td> 227 228<p> 229This function returns the C-style string for read access. 230<p> 231Implemented in <a class="el" href="group__osclutil.html#a68">OSCL_HeapString< Alloc ></a>, <a class="el" href="classOSCL__HeapStringA.html#a10">OSCL_HeapStringA</a>, <a class="el" href="group__osclutil.html#a108">OSCL_StackString< MaxBufSize ></a>, <a class="el" href="classOSCL__FastString.html#a7">OSCL_FastString</a>, and <a class="el" href="classOSCL__HeapString.html#a68">OSCL_HeapString< OsclMemAllocator ></a>. </td> 232 </tr> 233</table> 234<a name="a1" doxytag="OSCL_String::get_maxsize"></a><p> 235<table width="100%" cellpadding="2" cellspacing="0" border="0"> 236 <tr> 237 <td class="md"> 238 <table cellpadding="0" cellspacing="0" border="0"> 239 <tr> 240 <td class="md" nowrap valign="top"> virtual uint32 OSCL_String::get_maxsize </td> 241 <td class="md" valign="top">( </td> 242 <td class="mdname1" valign="top" nowrap> </td> 243 <td class="md" valign="top">) </td> 244 <td class="md" nowrap><code> [pure virtual]</code></td> 245 </tr> 246 247 </table> 248 </td> 249 </tr> 250</table> 251<table cellspacing=5 cellpadding=0 border=0> 252 <tr> 253 <td> 254 255 </td> 256 <td> 257 258<p> 259This function returns the maximum available storage size, not including null terminator. The maximum size may be larger than the current string size. 260<p> 261Implemented in <a class="el" href="group__osclutil.html#a66">OSCL_HeapString< Alloc ></a>, <a class="el" href="classOSCL__HeapStringA.html#a9">OSCL_HeapStringA</a>, <a class="el" href="group__osclutil.html#a106">OSCL_StackString< MaxBufSize ></a>, <a class="el" href="classOSCL__FastString.html#a6">OSCL_FastString</a>, and <a class="el" href="classOSCL__HeapString.html#a66">OSCL_HeapString< OsclMemAllocator ></a>. </td> 262 </tr> 263</table> 264<a name="a0" doxytag="OSCL_String::get_size"></a><p> 265<table width="100%" cellpadding="2" cellspacing="0" border="0"> 266 <tr> 267 <td class="md"> 268 <table cellpadding="0" cellspacing="0" border="0"> 269 <tr> 270 <td class="md" nowrap valign="top"> virtual uint32 OSCL_String::get_size </td> 271 <td class="md" valign="top">( </td> 272 <td class="mdname1" valign="top" nowrap> </td> 273 <td class="md" valign="top">) </td> 274 <td class="md" nowrap><code> [pure virtual]</code></td> 275 </tr> 276 277 </table> 278 </td> 279 </tr> 280</table> 281<table cellspacing=5 cellpadding=0 border=0> 282 <tr> 283 <td> 284 285 </td> 286 <td> 287 288<p> 289This function returns the string size not including the null-terminator. 290<p> 291Implemented in <a class="el" href="group__osclutil.html#a62">OSCL_HeapString< Alloc ></a>, <a class="el" href="classOSCL__HeapStringA.html#a8">OSCL_HeapStringA</a>, <a class="el" href="group__osclutil.html#a104">OSCL_StackString< MaxBufSize ></a>, <a class="el" href="classOSCL__FastString.html#a5">OSCL_FastString</a>, and <a class="el" href="classOSCL__HeapString.html#a62">OSCL_HeapString< OsclMemAllocator ></a>. </td> 292 </tr> 293</table> 294<a name="a4" doxytag="OSCL_String::get_str"></a><p> 295<table width="100%" cellpadding="2" cellspacing="0" border="0"> 296 <tr> 297 <td class="md"> 298 <table cellpadding="0" cellspacing="0" border="0"> 299 <tr> 300 <td class="md" nowrap valign="top"> virtual <a class="el" href="classOSCL__String.html#s0">chartype</a>* OSCL_String::get_str </td> 301 <td class="md" valign="top">( </td> 302 <td class="mdname1" valign="top" nowrap> </td> 303 <td class="md" valign="top">) </td> 304 <td class="md" nowrap><code> [pure virtual]</code></td> 305 </tr> 306 307 </table> 308 </td> 309 </tr> 310</table> 311<table cellspacing=5 cellpadding=0 border=0> 312 <tr> 313 <td> 314 315 </td> 316 <td> 317 318<p> 319This function returns the C-style string for write access. If the string is not writable it returns NULL. 320<p> 321Implemented in <a class="el" href="group__osclutil.html#a70">OSCL_HeapString< Alloc ></a>, <a class="el" href="classOSCL__HeapStringA.html#a11">OSCL_HeapStringA</a>, <a class="el" href="group__osclutil.html#a110">OSCL_StackString< MaxBufSize ></a>, <a class="el" href="classOSCL__FastString.html#a8">OSCL_FastString</a>, and <a class="el" href="classOSCL__HeapString.html#a70">OSCL_HeapString< OsclMemAllocator ></a>. </td> 322 </tr> 323</table> 324<a name="a19" doxytag="OSCL_String::hash"></a><p> 325<table width="100%" cellpadding="2" cellspacing="0" border="0"> 326 <tr> 327 <td class="md"> 328 <table cellpadding="0" cellspacing="0" border="0"> 329 <tr> 330 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF int8 OSCL_String::hash </td> 331 <td class="md" valign="top">( </td> 332 <td class="mdname1" valign="top" nowrap> </td> 333 <td class="md" valign="top">) </td> 334 <td class="md" nowrap><code> [virtual]</code></td> 335 </tr> 336 337 </table> 338 </td> 339 </tr> 340</table> 341<table cellspacing=5 cellpadding=0 border=0> 342 <tr> 343 <td> 344 345 </td> 346 <td> 347 348<p> 349This function performs a hash operation on the string. If the string is not writable, the function leaves. </td> 350 </tr> 351</table> 352<a name="a3" doxytag="OSCL_String::is_writable"></a><p> 353<table width="100%" cellpadding="2" cellspacing="0" border="0"> 354 <tr> 355 <td class="md"> 356 <table cellpadding="0" cellspacing="0" border="0"> 357 <tr> 358 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF bool OSCL_String::is_writable </td> 359 <td class="md" valign="top">( </td> 360 <td class="mdname1" valign="top" nowrap> </td> 361 <td class="md" valign="top">) </td> 362 <td class="md" nowrap><code> [virtual]</code></td> 363 </tr> 364 365 </table> 366 </td> 367 </tr> 368</table> 369<table cellspacing=5 cellpadding=0 border=0> 370 <tr> 371 <td> 372 373 </td> 374 <td> 375 376<p> 377This function returns true if the string is writable. </td> 378 </tr> 379</table> 380<a name="a11" doxytag="OSCL_String::operator!="></a><p> 381<table width="100%" cellpadding="2" cellspacing="0" border="0"> 382 <tr> 383 <td class="md"> 384 <table cellpadding="0" cellspacing="0" border="0"> 385 <tr> 386 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF bool OSCL_String::operator!= </td> 387 <td class="md" valign="top">( </td> 388 <td class="md" nowrap valign="top">const OSCL_String & </td> 389 <td class="mdname1" valign="top" nowrap> <em>src</em> </td> 390 <td class="md" valign="top">) </td> 391 <td class="md" nowrap> const</td> 392 </tr> 393 394 </table> 395 </td> 396 </tr> 397</table> 398<table cellspacing=5 cellpadding=0 border=0> 399 <tr> 400 <td> 401 402 </td> 403 <td> 404 405<p> 406 </td> 407 </tr> 408</table> 409<a name="a9" doxytag="OSCL_String::operator+="></a><p> 410<table width="100%" cellpadding="2" cellspacing="0" border="0"> 411 <tr> 412 <td class="md"> 413 <table cellpadding="0" cellspacing="0" border="0"> 414 <tr> 415 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF OSCL_String& OSCL_String::operator+= </td> 416 <td class="md" valign="top">( </td> 417 <td class="md" nowrap valign="top">const <a class="el" href="classOSCL__String.html#s0">chartype</a> </td> 418 <td class="mdname1" valign="top" nowrap> <em>c</em> </td> 419 <td class="md" valign="top">) </td> 420 <td class="md" nowrap></td> 421 </tr> 422 423 </table> 424 </td> 425 </tr> 426</table> 427<table cellspacing=5 cellpadding=0 border=0> 428 <tr> 429 <td> 430 431 </td> 432 <td> 433 434<p> 435Append operator. This operator appends the input character to this object. The string may be truncated to fit available storage. </td> 436 </tr> 437</table> 438<a name="a8" doxytag="OSCL_String::operator+="></a><p> 439<table width="100%" cellpadding="2" cellspacing="0" border="0"> 440 <tr> 441 <td class="md"> 442 <table cellpadding="0" cellspacing="0" border="0"> 443 <tr> 444 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF OSCL_String& OSCL_String::operator+= </td> 445 <td class="md" valign="top">( </td> 446 <td class="md" nowrap valign="top">const <a class="el" href="classOSCL__String.html#s0">chartype</a> * </td> 447 <td class="mdname1" valign="top" nowrap> <em>cstr</em> </td> 448 <td class="md" valign="top">) </td> 449 <td class="md" nowrap></td> 450 </tr> 451 452 </table> 453 </td> 454 </tr> 455</table> 456<table cellspacing=5 cellpadding=0 border=0> 457 <tr> 458 <td> 459 460 </td> 461 <td> 462 463<p> 464Append operator. This operator appends the input string to this object. The string may be truncated to fit available storage. <dl compact><dt><b>am: null-terminated string</b></dt><dd> 465</dl> </td> 466 </tr> 467</table> 468<a name="a7" doxytag="OSCL_String::operator+="></a><p> 469<table width="100%" cellpadding="2" cellspacing="0" border="0"> 470 <tr> 471 <td class="md"> 472 <table cellpadding="0" cellspacing="0" border="0"> 473 <tr> 474 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF OSCL_String& OSCL_String::operator+= </td> 475 <td class="md" valign="top">( </td> 476 <td class="md" nowrap valign="top">const OSCL_String & </td> 477 <td class="mdname1" valign="top" nowrap> <em>src</em> </td> 478 <td class="md" valign="top">) </td> 479 <td class="md" nowrap></td> 480 </tr> 481 482 </table> 483 </td> 484 </tr> 485</table> 486<table cellspacing=5 cellpadding=0 border=0> 487 <tr> 488 <td> 489 490 </td> 491 <td> 492 493<p> 494Append operator. This operator appends the input string to this object. The string may be truncated to fit available storage. </td> 495 </tr> 496</table> 497<a name="a12" doxytag="OSCL_String::operator<"></a><p> 498<table width="100%" cellpadding="2" cellspacing="0" border="0"> 499 <tr> 500 <td class="md"> 501 <table cellpadding="0" cellspacing="0" border="0"> 502 <tr> 503 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF bool OSCL_String::operator< </td> 504 <td class="md" valign="top">( </td> 505 <td class="md" nowrap valign="top">const OSCL_String & </td> 506 <td class="mdname1" valign="top" nowrap> <em>src</em> </td> 507 <td class="md" valign="top">) </td> 508 <td class="md" nowrap> const</td> 509 </tr> 510 511 </table> 512 </td> 513 </tr> 514</table> 515<table cellspacing=5 cellpadding=0 border=0> 516 <tr> 517 <td> 518 519 </td> 520 <td> 521 522<p> 523 </td> 524 </tr> 525</table> 526<a name="a13" doxytag="OSCL_String::operator<="></a><p> 527<table width="100%" cellpadding="2" cellspacing="0" border="0"> 528 <tr> 529 <td class="md"> 530 <table cellpadding="0" cellspacing="0" border="0"> 531 <tr> 532 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF bool OSCL_String::operator<= </td> 533 <td class="md" valign="top">( </td> 534 <td class="md" nowrap valign="top">const OSCL_String & </td> 535 <td class="mdname1" valign="top" nowrap> <em>src</em> </td> 536 <td class="md" valign="top">) </td> 537 <td class="md" nowrap> const</td> 538 </tr> 539 540 </table> 541 </td> 542 </tr> 543</table> 544<table cellspacing=5 cellpadding=0 border=0> 545 <tr> 546 <td> 547 548 </td> 549 <td> 550 551<p> 552 </td> 553 </tr> 554</table> 555<a name="a6" doxytag="OSCL_String::operator="></a><p> 556<table width="100%" cellpadding="2" cellspacing="0" border="0"> 557 <tr> 558 <td class="md"> 559 <table cellpadding="0" cellspacing="0" border="0"> 560 <tr> 561 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF OSCL_String& OSCL_String::operator= </td> 562 <td class="md" valign="top">( </td> 563 <td class="md" nowrap valign="top">const <a class="el" href="classOSCL__String.html#s0">chartype</a> * </td> 564 <td class="mdname1" valign="top" nowrap> <em>cstr</em> </td> 565 <td class="md" valign="top">) </td> 566 <td class="md" nowrap></td> 567 </tr> 568 569 </table> 570 </td> 571 </tr> 572</table> 573<table cellspacing=5 cellpadding=0 border=0> 574 <tr> 575 <td> 576 577 </td> 578 <td> 579 580<p> 581Assignment operator <dl compact><dt><b>am: null-terminated string</b></dt><dd> 582</dl> 583<p> 584Reimplemented in <a class="el" href="group__osclutil.html#a92">OSCL_HeapString< Alloc ></a>, <a class="el" href="classOSCL__HeapStringA.html#a14">OSCL_HeapStringA</a>, <a class="el" href="group__osclutil.html#a132">OSCL_StackString< MaxBufSize ></a>, <a class="el" href="classOSCL__FastString.html#a10">OSCL_FastString</a>, and <a class="el" href="classOSCL__HeapString.html#a92">OSCL_HeapString< OsclMemAllocator ></a>. </td> 585 </tr> 586</table> 587<a name="a5" doxytag="OSCL_String::operator="></a><p> 588<table width="100%" cellpadding="2" cellspacing="0" border="0"> 589 <tr> 590 <td class="md"> 591 <table cellpadding="0" cellspacing="0" border="0"> 592 <tr> 593 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF OSCL_String& OSCL_String::operator= </td> 594 <td class="md" valign="top">( </td> 595 <td class="md" nowrap valign="top">const OSCL_String & </td> 596 <td class="mdname1" valign="top" nowrap> <em>src</em> </td> 597 <td class="md" valign="top">) </td> 598 <td class="md" nowrap></td> 599 </tr> 600 601 </table> 602 </td> 603 </tr> 604</table> 605<table cellspacing=5 cellpadding=0 border=0> 606 <tr> 607 <td> 608 609 </td> 610 <td> 611 612<p> 613Assignment operator 614<p> 615Reimplemented in <a class="el" href="group__osclutil.html#a90">OSCL_HeapString< Alloc ></a>, <a class="el" href="classOSCL__HeapStringA.html#a13">OSCL_HeapStringA</a>, <a class="el" href="group__osclutil.html#a130">OSCL_StackString< MaxBufSize ></a>, and <a class="el" href="classOSCL__HeapString.html#a90">OSCL_HeapString< OsclMemAllocator ></a>. </td> 616 </tr> 617</table> 618<a name="a16" doxytag="OSCL_String::operator=="></a><p> 619<table width="100%" cellpadding="2" cellspacing="0" border="0"> 620 <tr> 621 <td class="md"> 622 <table cellpadding="0" cellspacing="0" border="0"> 623 <tr> 624 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF bool OSCL_String::operator== </td> 625 <td class="md" valign="top">( </td> 626 <td class="md" nowrap valign="top">const <a class="el" href="classOSCL__String.html#s0">chartype</a> * </td> 627 <td class="mdname1" valign="top" nowrap> <em>cstr</em> </td> 628 <td class="md" valign="top">) </td> 629 <td class="md" nowrap> const</td> 630 </tr> 631 632 </table> 633 </td> 634 </tr> 635</table> 636<table cellspacing=5 cellpadding=0 border=0> 637 <tr> 638 <td> 639 640 </td> 641 <td> 642 643<p> 644Comparison operator <dl compact><dt><b>am: null-terminated string</b></dt><dd> 645</dl> </td> 646 </tr> 647</table> 648<a name="a10" doxytag="OSCL_String::operator=="></a><p> 649<table width="100%" cellpadding="2" cellspacing="0" border="0"> 650 <tr> 651 <td class="md"> 652 <table cellpadding="0" cellspacing="0" border="0"> 653 <tr> 654 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF bool OSCL_String::operator== </td> 655 <td class="md" valign="top">( </td> 656 <td class="md" nowrap valign="top">const OSCL_String & </td> 657 <td class="mdname1" valign="top" nowrap> <em>src</em> </td> 658 <td class="md" valign="top">) </td> 659 <td class="md" nowrap> const</td> 660 </tr> 661 662 </table> 663 </td> 664 </tr> 665</table> 666<table cellspacing=5 cellpadding=0 border=0> 667 <tr> 668 <td> 669 670 </td> 671 <td> 672 673<p> 674Comparison operators </td> 675 </tr> 676</table> 677<a name="a14" doxytag="OSCL_String::operator>"></a><p> 678<table width="100%" cellpadding="2" cellspacing="0" border="0"> 679 <tr> 680 <td class="md"> 681 <table cellpadding="0" cellspacing="0" border="0"> 682 <tr> 683 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF bool OSCL_String::operator> </td> 684 <td class="md" valign="top">( </td> 685 <td class="md" nowrap valign="top">const OSCL_String & </td> 686 <td class="mdname1" valign="top" nowrap> <em>src</em> </td> 687 <td class="md" valign="top">) </td> 688 <td class="md" nowrap> const</td> 689 </tr> 690 691 </table> 692 </td> 693 </tr> 694</table> 695<table cellspacing=5 cellpadding=0 border=0> 696 <tr> 697 <td> 698 699 </td> 700 <td> 701 702<p> 703 </td> 704 </tr> 705</table> 706<a name="a15" doxytag="OSCL_String::operator>="></a><p> 707<table width="100%" cellpadding="2" cellspacing="0" border="0"> 708 <tr> 709 <td class="md"> 710 <table cellpadding="0" cellspacing="0" border="0"> 711 <tr> 712 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF bool OSCL_String::operator>= </td> 713 <td class="md" valign="top">( </td> 714 <td class="md" nowrap valign="top">const OSCL_String & </td> 715 <td class="mdname1" valign="top" nowrap> <em>src</em> </td> 716 <td class="md" valign="top">) </td> 717 <td class="md" nowrap> const</td> 718 </tr> 719 720 </table> 721 </td> 722 </tr> 723</table> 724<table cellspacing=5 cellpadding=0 border=0> 725 <tr> 726 <td> 727 728 </td> 729 <td> 730 731<p> 732 </td> 733 </tr> 734</table> 735<a name="a17" doxytag="OSCL_String::operator[]"></a><p> 736<table width="100%" cellpadding="2" cellspacing="0" border="0"> 737 <tr> 738 <td class="md"> 739 <table cellpadding="0" cellspacing="0" border="0"> 740 <tr> 741 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF <a class="el" href="classOSCL__String.html#s0">chartype</a> OSCL_String::operator[] </td> 742 <td class="md" valign="top">( </td> 743 <td class="md" nowrap valign="top">uint32 </td> 744 <td class="mdname1" valign="top" nowrap> <em>index</em> </td> 745 <td class="md" valign="top">) </td> 746 <td class="md" nowrap> const</td> 747 </tr> 748 749 </table> 750 </td> 751 </tr> 752</table> 753<table cellspacing=5 cellpadding=0 border=0> 754 <tr> 755 <td> 756 757 </td> 758 <td> 759 760<p> 761This is subscript notation to access a character at the given position. If the index is outside the current size range then the function leaves. </td> 762 </tr> 763</table> 764<a name="a18" doxytag="OSCL_String::read"></a><p> 765<table width="100%" cellpadding="2" cellspacing="0" border="0"> 766 <tr> 767 <td class="md"> 768 <table cellpadding="0" cellspacing="0" border="0"> 769 <tr> 770 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF <a class="el" href="classOSCL__String.html#s0">chartype</a> OSCL_String::read </td> 771 <td class="md" valign="top">( </td> 772 <td class="md" nowrap valign="top">uint32 </td> 773 <td class="mdname1" valign="top" nowrap> <em>index</em> </td> 774 <td class="md" valign="top">) </td> 775 <td class="md" nowrap> const<code> [virtual]</code></td> 776 </tr> 777 778 </table> 779 </td> 780 </tr> 781</table> 782<table cellspacing=5 cellpadding=0 border=0> 783 <tr> 784 <td> 785 786 </td> 787 <td> 788 789<p> 790This function returns the character at the given position. If the index is outside the current size range then the function leaves. </td> 791 </tr> 792</table> 793<a name="b6" doxytag="OSCL_String::set_len"></a><p> 794<table width="100%" cellpadding="2" cellspacing="0" border="0"> 795 <tr> 796 <td class="md"> 797 <table cellpadding="0" cellspacing="0" border="0"> 798 <tr> 799 <td class="md" nowrap valign="top"> virtual void OSCL_String::set_len </td> 800 <td class="md" valign="top">( </td> 801 <td class="md" nowrap valign="top">uint32 </td> 802 <td class="mdname1" valign="top" nowrap> <em>len</em> </td> 803 <td class="md" valign="top">) </td> 804 <td class="md" nowrap><code> [protected, pure virtual]</code></td> 805 </tr> 806 807 </table> 808 </td> 809 </tr> 810</table> 811<table cellspacing=5 cellpadding=0 border=0> 812 <tr> 813 <td> 814 815 </td> 816 <td> 817 818<p> 819Update the length of the string. This function will only be called when the string is writable. </td> 820 </tr> 821</table> 822<a name="b4" doxytag="OSCL_String::set_rep"></a><p> 823<table width="100%" cellpadding="2" cellspacing="0" border="0"> 824 <tr> 825 <td class="md"> 826 <table cellpadding="0" cellspacing="0" border="0"> 827 <tr> 828 <td class="md" nowrap valign="top"> virtual void OSCL_String::set_rep </td> 829 <td class="md" valign="top">( </td> 830 <td class="md" nowrap valign="top">const OSCL_String & </td> 831 <td class="mdname1" valign="top" nowrap> <em>src</em> </td> 832 <td class="md" valign="top">) </td> 833 <td class="md" nowrap><code> [protected, pure virtual]</code></td> 834 </tr> 835 836 </table> 837 </td> 838 </tr> 839</table> 840<table cellspacing=5 cellpadding=0 border=0> 841 <tr> 842 <td> 843 844 </td> 845 <td> 846 847<p> 848Set string representation to input string. </td> 849 </tr> 850</table> 851<a name="b2" doxytag="OSCL_String::set_rep"></a><p> 852<table width="100%" cellpadding="2" cellspacing="0" border="0"> 853 <tr> 854 <td class="md"> 855 <table cellpadding="0" cellspacing="0" border="0"> 856 <tr> 857 <td class="md" nowrap valign="top"> virtual void OSCL_String::set_rep </td> 858 <td class="md" valign="top">( </td> 859 <td class="md" nowrap valign="top">const <a class="el" href="classOSCL__String.html#s0">chartype</a> * </td> 860 <td class="mdname1" valign="top" nowrap> <em>cstr</em> </td> 861 <td class="md" valign="top">) </td> 862 <td class="md" nowrap><code> [protected, pure virtual]</code></td> 863 </tr> 864 865 </table> 866 </td> 867 </tr> 868</table> 869<table cellspacing=5 cellpadding=0 border=0> 870 <tr> 871 <td> 872 873 </td> 874 <td> 875 876<p> 877Set string representation to input null-terminated string. </td> 878 </tr> 879</table> 880<a name="a21" doxytag="OSCL_String::write"></a><p> 881<table width="100%" cellpadding="2" cellspacing="0" border="0"> 882 <tr> 883 <td class="md"> 884 <table cellpadding="0" cellspacing="0" border="0"> 885 <tr> 886 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF void OSCL_String::write </td> 887 <td class="md" valign="top">( </td> 888 <td class="md" nowrap valign="top">uint32 </td> 889 <td class="mdname" nowrap> <em>offset</em>, </td> 890 </tr> 891 <tr> 892 <td></td> 893 <td></td> 894 <td class="md" nowrap>uint32 </td> 895 <td class="mdname" nowrap> <em>length</em>, </td> 896 </tr> 897 <tr> 898 <td></td> 899 <td></td> 900 <td class="md" nowrap>const <a class="el" href="classOSCL__String.html#s0">chartype</a> * </td> 901 <td class="mdname" nowrap> <em>buf</em></td> 902 </tr> 903 <tr> 904 <td></td> 905 <td class="md">) </td> 906 <td class="md" colspan="2"><code> [virtual]</code></td> 907 </tr> 908 909 </table> 910 </td> 911 </tr> 912</table> 913<table cellspacing=5 cellpadding=0 border=0> 914 <tr> 915 <td> 916 917 </td> 918 <td> 919 920<p> 921This function replaces characters at the specified offset within the current string. If the string is not writable, the function leaves. The characters may be truncted to fit the current storage. <dl compact><dt><b>Parameters: </b></dt><dd> 922<table border=0 cellspacing=2 cellpadding=0> 923<tr><td valign=top><em>offset:</em> </td><td> 924the offset into the existing string buffer </td></tr> 925<tr><td valign=top><em>length:</em> </td><td> 926number of characters to copy. </td></tr> 927<tr><td valign=top><em>ptr:</em> </td><td> 928character buffer, not necessarily null-terminated. </td></tr> 929</table> 930</dl> </td> 931 </tr> 932</table> 933<a name="a20" doxytag="OSCL_String::write"></a><p> 934<table width="100%" cellpadding="2" cellspacing="0" border="0"> 935 <tr> 936 <td class="md"> 937 <table cellpadding="0" cellspacing="0" border="0"> 938 <tr> 939 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF void OSCL_String::write </td> 940 <td class="md" valign="top">( </td> 941 <td class="md" nowrap valign="top">uint32 </td> 942 <td class="mdname" nowrap> <em>index</em>, </td> 943 </tr> 944 <tr> 945 <td></td> 946 <td></td> 947 <td class="md" nowrap><a class="el" href="classOSCL__String.html#s0">chartype</a> </td> 948 <td class="mdname" nowrap> <em>c</em></td> 949 </tr> 950 <tr> 951 <td></td> 952 <td class="md">) </td> 953 <td class="md" colspan="2"><code> [virtual]</code></td> 954 </tr> 955 956 </table> 957 </td> 958 </tr> 959</table> 960<table cellspacing=5 cellpadding=0 border=0> 961 <tr> 962 <td> 963 964 </td> 965 <td> 966 967<p> 968This function stores a character at the specified position. If the string is not writable, the function leaves. If the index is outside the current size range then the function leaves. </td> 969 </tr> 970</table> 971<hr>The documentation for this class was generated from the following file:<ul> 972<li><a class="el" href="oscl__string_8h-source.html">oscl_string.h</a></ul> 973<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small> 974<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small> 975</small></address> 976</body> 977</html> 978
