blob: b26fba289e3c000d8dc7a3f9dc171439cb6fb224 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>OSCL_String class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="modules.html">Modules</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="globals.html">Globals</a> &nbsp; </center>
<hr><h1>OSCL_String Class Reference<br>
<small>
[<a class="el" href="group__osclutil.html">OSCL Util</a>]</small>
</h1><code>#include &lt;<a class="el" href="oscl__string_8h-source.html">oscl_string.h</a>&gt;</code>
<p>
<p>Inheritance diagram for OSCL_String:
<p><center><img src="classOSCL__String.png" usemap="#OSCL_String_map" border="0" alt=""></center>
<map name="OSCL_String_map">
<area href="classHeapBase.html" alt="HeapBase" shape="rect" coords="327,56,535,80">
<area href="class__OsclHeapBase.html" alt="_OsclHeapBase" shape="rect" coords="327,0,535,24">
<area href="classOSCL__FastString.html" alt="OSCL_FastString" shape="rect" coords="0,168,208,192">
<area href="classOSCL__HeapString.html" alt="OSCL_HeapString< Alloc >" shape="rect" coords="218,168,426,192">
<area href="classOSCL__HeapStringA.html" alt="OSCL_HeapStringA" shape="rect" coords="436,168,644,192">
<area href="classOSCL__StackString.html" alt="OSCL_StackString< MaxBufSize >" shape="rect" coords="654,168,862,192">
</map>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
<tr><td nowrap align=right valign=top>typedef char&nbsp;</td><td valign=bottom><a class="el" href="classOSCL__String.html#s0">chartype</a></td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>virtual uint32&nbsp;</td><td valign=bottom><a class="el" href="classOSCL__String.html#a0">get_size</a> () const=0</td></tr>
<tr><td nowrap align=right valign=top>virtual uint32&nbsp;</td><td valign=bottom><a class="el" href="classOSCL__String.html#a1">get_maxsize</a> () const=0</td></tr>
<tr><td nowrap align=right valign=top>virtual const <a class="el" href="classOSCL__String.html#s0">chartype</a> *&nbsp;</td><td valign=bottom><a class="el" href="classOSCL__String.html#a2">get_cstr</a> () const=0</td></tr>
<tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF bool&nbsp;</td><td valign=bottom><a class="el" href="classOSCL__String.html#a3">is_writable</a> () const</td></tr>
<tr><td nowrap align=right valign=top>virtual <a class="el" href="classOSCL__String.html#s0">chartype</a> *&nbsp;</td><td valign=bottom><a class="el" href="classOSCL__String.html#a4">get_str</a> () const=0</td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF OSCL_String &amp;&nbsp;</td><td valign=bottom><a class="el" href="classOSCL__String.html#a5">operator=</a> (const OSCL_String &amp;src)</td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF OSCL_String &amp;&nbsp;</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>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF OSCL_String &amp;&nbsp;</td><td valign=bottom><a class="el" href="classOSCL__String.html#a7">operator+=</a> (const OSCL_String &amp;src)</td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF OSCL_String &amp;&nbsp;</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>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF OSCL_String &amp;&nbsp;</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>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF bool&nbsp;</td><td valign=bottom><a class="el" href="classOSCL__String.html#a10">operator==</a> (const OSCL_String &amp;src) const</td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF bool&nbsp;</td><td valign=bottom><a class="el" href="classOSCL__String.html#a11">operator!=</a> (const OSCL_String &amp;src) const</td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF bool&nbsp;</td><td valign=bottom><a class="el" href="classOSCL__String.html#a12">operator&lt;</a> (const OSCL_String &amp;src) const</td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF bool&nbsp;</td><td valign=bottom><a class="el" href="classOSCL__String.html#a13">operator&lt;=</a> (const OSCL_String &amp;src) const</td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF bool&nbsp;</td><td valign=bottom><a class="el" href="classOSCL__String.html#a14">operator&gt;</a> (const OSCL_String &amp;src) const</td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF bool&nbsp;</td><td valign=bottom><a class="el" href="classOSCL__String.html#a15">operator&gt;=</a> (const OSCL_String &amp;src) const</td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF bool&nbsp;</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>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF <a class="el" href="classOSCL__String.html#s0">chartype</a>&nbsp;</td><td valign=bottom><a class="el" href="classOSCL__String.html#a17">operator[]</a> (uint32 index) const</td></tr>
<tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF <a class="el" href="classOSCL__String.html#s0">chartype</a>&nbsp;</td><td valign=bottom><a class="el" href="classOSCL__String.html#a18">read</a> (uint32 index) const</td></tr>
<tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF int8&nbsp;</td><td valign=bottom><a class="el" href="classOSCL__String.html#a19">hash</a> () const</td></tr>
<tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF void&nbsp;</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>
<tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF void&nbsp;</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>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF&nbsp;</td><td valign=bottom><a class="el" href="classOSCL__String.html#b0">OSCL_String</a> ()</td></tr>
<tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF&nbsp;</td><td valign=bottom><a class="el" href="classOSCL__String.html#b1">~OSCL_String</a> ()</td></tr>
<tr><td nowrap align=right valign=top>virtual void&nbsp;</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>
<tr><td nowrap align=right valign=top>virtual void&nbsp;</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>
<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classOSCL__String.html#b4">set_rep</a> (const OSCL_String &amp;src)=0</td></tr>
<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classOSCL__String.html#b5">append_rep</a> (const OSCL_String &amp;src)=0</td></tr>
<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classOSCL__String.html#b6">set_len</a> (uint32 len)=0</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A common base class for string classes with "char" character format
<p>
<hr><h2>Member Typedef Documentation</h2>
<a name="s0" doxytag="OSCL_String::chartype"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef char OSCL_String::chartype
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<p>
Reimplemented in <a class="el" href="classOSCL__HeapString.html#s0">OSCL_HeapString&lt; Alloc &gt;</a>, <a class="el" href="classOSCL__HeapStringA.html#s0">OSCL_HeapStringA</a>, <a class="el" href="classOSCL__StackString.html#s0">OSCL_StackString&lt; MaxBufSize &gt;</a>, <a class="el" href="classOSCL__FastString.html#s0">OSCL_FastString</a>, and <a class="el" href="classOSCL__HeapString.html#s0">OSCL_HeapString&lt; OsclMemAllocator &gt;</a>. </td>
</tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="b0" doxytag="OSCL_String::OSCL_String"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF OSCL_String::OSCL_String </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="b1" doxytag="OSCL_String::~OSCL_String"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF OSCL_String::~OSCL_String </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="b5" doxytag="OSCL_String::append_rep"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void OSCL_String::append_rep </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const OSCL_String &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>src</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [protected, pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Append the input string to the current string. The string may be truncated to fit the available storage. </td>
</tr>
</table>
<a name="b3" doxytag="OSCL_String::append_rep"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void OSCL_String::append_rep </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <a class="el" href="classOSCL__String.html#s0">chartype</a> *&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>cstr</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [protected, pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Append the input null-terminated string to the current string. The string may be truncated to fit the available storage. </td>
</tr>
</table>
<a name="a2" doxytag="OSCL_String::get_cstr"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual const <a class="el" href="classOSCL__String.html#s0">chartype</a>* OSCL_String::get_cstr </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This function returns the C-style string for read access.
<p>
Implemented in <a class="el" href="group__osclutil.html#a68">OSCL_HeapString&lt; Alloc &gt;</a>, <a class="el" href="classOSCL__HeapStringA.html#a10">OSCL_HeapStringA</a>, <a class="el" href="group__osclutil.html#a108">OSCL_StackString&lt; MaxBufSize &gt;</a>, <a class="el" href="classOSCL__FastString.html#a7">OSCL_FastString</a>, and <a class="el" href="classOSCL__HeapString.html#a68">OSCL_HeapString&lt; OsclMemAllocator &gt;</a>. </td>
</tr>
</table>
<a name="a1" doxytag="OSCL_String::get_maxsize"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual uint32 OSCL_String::get_maxsize </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This function returns the maximum available storage size, not including null terminator. The maximum size may be larger than the current string size.
<p>
Implemented in <a class="el" href="group__osclutil.html#a66">OSCL_HeapString&lt; Alloc &gt;</a>, <a class="el" href="classOSCL__HeapStringA.html#a9">OSCL_HeapStringA</a>, <a class="el" href="group__osclutil.html#a106">OSCL_StackString&lt; MaxBufSize &gt;</a>, <a class="el" href="classOSCL__FastString.html#a6">OSCL_FastString</a>, and <a class="el" href="classOSCL__HeapString.html#a66">OSCL_HeapString&lt; OsclMemAllocator &gt;</a>. </td>
</tr>
</table>
<a name="a0" doxytag="OSCL_String::get_size"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual uint32 OSCL_String::get_size </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This function returns the string size not including the null-terminator.
<p>
Implemented in <a class="el" href="group__osclutil.html#a62">OSCL_HeapString&lt; Alloc &gt;</a>, <a class="el" href="classOSCL__HeapStringA.html#a8">OSCL_HeapStringA</a>, <a class="el" href="group__osclutil.html#a104">OSCL_StackString&lt; MaxBufSize &gt;</a>, <a class="el" href="classOSCL__FastString.html#a5">OSCL_FastString</a>, and <a class="el" href="classOSCL__HeapString.html#a62">OSCL_HeapString&lt; OsclMemAllocator &gt;</a>. </td>
</tr>
</table>
<a name="a4" doxytag="OSCL_String::get_str"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual <a class="el" href="classOSCL__String.html#s0">chartype</a>* OSCL_String::get_str </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This function returns the C-style string for write access. If the string is not writable it returns NULL.
<p>
Implemented in <a class="el" href="group__osclutil.html#a70">OSCL_HeapString&lt; Alloc &gt;</a>, <a class="el" href="classOSCL__HeapStringA.html#a11">OSCL_HeapStringA</a>, <a class="el" href="group__osclutil.html#a110">OSCL_StackString&lt; MaxBufSize &gt;</a>, <a class="el" href="classOSCL__FastString.html#a8">OSCL_FastString</a>, and <a class="el" href="classOSCL__HeapString.html#a70">OSCL_HeapString&lt; OsclMemAllocator &gt;</a>. </td>
</tr>
</table>
<a name="a19" doxytag="OSCL_String::hash"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF int8 OSCL_String::hash </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This function performs a hash operation on the string. If the string is not writable, the function leaves. </td>
</tr>
</table>
<a name="a3" doxytag="OSCL_String::is_writable"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF bool OSCL_String::is_writable </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This function returns true if the string is writable. </td>
</tr>
</table>
<a name="a11" doxytag="OSCL_String::operator!="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF bool OSCL_String::operator!= </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const OSCL_String &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>src</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a9" doxytag="OSCL_String::operator+="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF OSCL_String&amp; OSCL_String::operator+= </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <a class="el" href="classOSCL__String.html#s0">chartype</a>&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>c</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Append operator. This operator appends the input character to this object. The string may be truncated to fit available storage. </td>
</tr>
</table>
<a name="a8" doxytag="OSCL_String::operator+="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF OSCL_String&amp; OSCL_String::operator+= </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <a class="el" href="classOSCL__String.html#s0">chartype</a> *&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>cstr</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Append 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>
</dl> </td>
</tr>
</table>
<a name="a7" doxytag="OSCL_String::operator+="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF OSCL_String&amp; OSCL_String::operator+= </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const OSCL_String &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>src</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Append operator. This operator appends the input string to this object. The string may be truncated to fit available storage. </td>
</tr>
</table>
<a name="a12" doxytag="OSCL_String::operator<"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF bool OSCL_String::operator&lt; </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const OSCL_String &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>src</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a13" doxytag="OSCL_String::operator<="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF bool OSCL_String::operator&lt;= </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const OSCL_String &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>src</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a6" doxytag="OSCL_String::operator="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF OSCL_String&amp; OSCL_String::operator= </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <a class="el" href="classOSCL__String.html#s0">chartype</a> *&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>cstr</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Assignment operator <dl compact><dt><b>am: null-terminated string</b></dt><dd>
</dl>
<p>
Reimplemented in <a class="el" href="group__osclutil.html#a92">OSCL_HeapString&lt; Alloc &gt;</a>, <a class="el" href="classOSCL__HeapStringA.html#a14">OSCL_HeapStringA</a>, <a class="el" href="group__osclutil.html#a132">OSCL_StackString&lt; MaxBufSize &gt;</a>, <a class="el" href="classOSCL__FastString.html#a10">OSCL_FastString</a>, and <a class="el" href="classOSCL__HeapString.html#a92">OSCL_HeapString&lt; OsclMemAllocator &gt;</a>. </td>
</tr>
</table>
<a name="a5" doxytag="OSCL_String::operator="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF OSCL_String&amp; OSCL_String::operator= </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const OSCL_String &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>src</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Assignment operator
<p>
Reimplemented in <a class="el" href="group__osclutil.html#a90">OSCL_HeapString&lt; Alloc &gt;</a>, <a class="el" href="classOSCL__HeapStringA.html#a13">OSCL_HeapStringA</a>, <a class="el" href="group__osclutil.html#a130">OSCL_StackString&lt; MaxBufSize &gt;</a>, and <a class="el" href="classOSCL__HeapString.html#a90">OSCL_HeapString&lt; OsclMemAllocator &gt;</a>. </td>
</tr>
</table>
<a name="a16" doxytag="OSCL_String::operator=="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF bool OSCL_String::operator== </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <a class="el" href="classOSCL__String.html#s0">chartype</a> *&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>cstr</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Comparison operator <dl compact><dt><b>am: null-terminated string</b></dt><dd>
</dl> </td>
</tr>
</table>
<a name="a10" doxytag="OSCL_String::operator=="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF bool OSCL_String::operator== </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const OSCL_String &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>src</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Comparison operators </td>
</tr>
</table>
<a name="a14" doxytag="OSCL_String::operator>"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF bool OSCL_String::operator&gt; </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const OSCL_String &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>src</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a15" doxytag="OSCL_String::operator>="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF bool OSCL_String::operator&gt;= </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const OSCL_String &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>src</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a17" doxytag="OSCL_String::operator[]"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF <a class="el" href="classOSCL__String.html#s0">chartype</a> OSCL_String::operator[] </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">uint32&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>index</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This 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>
</tr>
</table>
<a name="a18" doxytag="OSCL_String::read"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF <a class="el" href="classOSCL__String.html#s0">chartype</a> OSCL_String::read </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">uint32&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>index</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This function returns the character at the given position. If the index is outside the current size range then the function leaves. </td>
</tr>
</table>
<a name="b6" doxytag="OSCL_String::set_len"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void OSCL_String::set_len </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">uint32&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>len</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [protected, pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Update the length of the string. This function will only be called when the string is writable. </td>
</tr>
</table>
<a name="b4" doxytag="OSCL_String::set_rep"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void OSCL_String::set_rep </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const OSCL_String &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>src</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [protected, pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set string representation to input string. </td>
</tr>
</table>
<a name="b2" doxytag="OSCL_String::set_rep"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void OSCL_String::set_rep </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <a class="el" href="classOSCL__String.html#s0">chartype</a> *&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>cstr</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [protected, pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set string representation to input null-terminated string. </td>
</tr>
</table>
<a name="a21" doxytag="OSCL_String::write"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF void OSCL_String::write </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">uint32&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>offset</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>uint32&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>length</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const <a class="el" href="classOSCL__String.html#s0">chartype</a> *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>buf</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This 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>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>offset:</em>&nbsp;</td><td>
the offset into the existing string buffer </td></tr>
<tr><td valign=top><em>length:</em>&nbsp;</td><td>
number of characters to copy. </td></tr>
<tr><td valign=top><em>ptr:</em>&nbsp;</td><td>
character buffer, not necessarily null-terminated. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a20" doxytag="OSCL_String::write"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF void OSCL_String::write </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">uint32&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>index</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="classOSCL__String.html#s0">chartype</a>&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>c</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This 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>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="oscl__string_8h-source.html">oscl_string.h</a></ul>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
</small></address>
</body>
</html>