blob: e24cd9f2908f428de682f298a35d92b5198446fc [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> TemplateOSCL_StackString&lt; MaxBufSize &gt; 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_StackString&lt; MaxBufSize &gt; Class Template Reference<br>
<small>
[<a class="el" href="group__osclutil.html">OSCL Util</a>]</small>
</h1><code>#include &lt;<a class="el" href="oscl__string__containers_8h-source.html">oscl_string_containers.h</a>&gt;</code>
<p>
<p>Inheritance diagram for OSCL_StackString&lt; MaxBufSize &gt;:
<p><center><img src="classOSCL__StackString.png" usemap="#OSCL_StackString< MaxBufSize >_map" border="0" alt=""></center>
<map name="OSCL_StackString< MaxBufSize >_map">
<area href="classOSCL__String.html" alt="OSCL_String" shape="rect" coords="0,112,208,136">
<area href="classHeapBase.html" alt="HeapBase" shape="rect" coords="0,56,208,80">
<area href="class__OsclHeapBase.html" alt="_OsclHeapBase" shape="rect" coords="0,0,208,24">
</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 OSCL_String::chartype&nbsp;</td><td valign=bottom><a class="el" href="classOSCL__StackString.html#s0">chartype</a></td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="group__osclutil.html#a114">OSCL_StackString</a> ()</td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="group__osclutil.html#a122">OSCL_StackString</a> (const OSCL_StackString &amp;src)</td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="group__osclutil.html#a124">OSCL_StackString</a> (const <a class="el" href="classOSCL__String.html">OSCL_String</a> &amp;src)</td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="group__osclutil.html#a116">OSCL_StackString</a> (const <a class="el" href="classOSCL__StackString.html#s0">chartype</a> *cstr)</td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="group__osclutil.html#a120">OSCL_StackString</a> (const <a class="el" href="classOSCL__StackString.html#s0">chartype</a> *buf, uint32 length)</td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="group__osclutil.html#a126">~OSCL_StackString</a> ()</td></tr>
<tr><td nowrap align=right valign=top>uint32&nbsp;</td><td valign=bottom><a class="el" href="group__osclutil.html#a104">get_size</a> () const</td></tr>
<tr><td nowrap align=right valign=top>uint32&nbsp;</td><td valign=bottom><a class="el" href="group__osclutil.html#a106">get_maxsize</a> () const</td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classOSCL__StackString.html#s0">chartype</a> *&nbsp;</td><td valign=bottom><a class="el" href="group__osclutil.html#a108">get_cstr</a> () const</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOSCL__StackString.html#s0">chartype</a> *&nbsp;</td><td valign=bottom><a class="el" href="group__osclutil.html#a110">get_str</a> () const</td></tr>
<tr><td nowrap align=right valign=top>OSCL_StackString &amp;&nbsp;</td><td valign=bottom><a class="el" href="group__osclutil.html#a128">operator=</a> (const OSCL_StackString &amp;src)</td></tr>
<tr><td nowrap align=right valign=top>OSCL_StackString &amp;&nbsp;</td><td valign=bottom><a class="el" href="group__osclutil.html#a130">operator=</a> (const <a class="el" href="classOSCL__String.html">OSCL_String</a> &amp;src)</td></tr>
<tr><td nowrap align=right valign=top>OSCL_StackString &amp;&nbsp;</td><td valign=bottom><a class="el" href="group__osclutil.html#a132">operator=</a> (const <a class="el" href="classOSCL__StackString.html#s0">chartype</a> *cstr)</td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="group__osclutil.html#a118">set</a> (const <a class="el" href="classOSCL__StackString.html#s0">chartype</a> *buf, uint32 length)</td></tr>
<tr><td colspan=2><br><h2>Friends</h2></td></tr>
<tr><td nowrap align=right valign=top>class&nbsp;</td><td valign=bottom><a class="el" href="classOSCL__StackString.html#l0">OSCL_String</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;uint32 MaxBufSize&gt;<br>
class OSCL_StackString&lt; MaxBufSize &gt;</h3>
OSCL_StackString is a simple string class, compatible with regular character array strings.
<p>
The string array is fixed length, is allocated from the stack, and is modifiable. Operations that update the string will automatically truncate it to fit the fixed size storage. This is recommended for use for short strings (&lt;255). Use <a class="el" href="classOSCL__HeapString.html">OSCL_HeapString</a> for very large strings to avoid stack overflow.<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>C:</em>&nbsp;</td><td>
type of character. </td></tr>
<tr><td valign=top><em>MaxBufSize:</em>&nbsp;</td><td>
maximum string length not including null terminator. </td></tr>
</table>
</dl>
<p>
<hr><h2>Member Typedef Documentation</h2>
<a name="s0" doxytag="OSCL_StackString::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" colspan="4">
template&lt;uint32 MaxBufSize&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> typedef OSCL_String::chartype OSCL_StackString&lt; MaxBufSize &gt;::chartype
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<p>
Reimplemented from <a class="el" href="classOSCL__String.html#s0">OSCL_String</a>. </td>
</tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a name="l0" doxytag="OSCL_StackString::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" colspan="4">
template&lt;uint32 MaxBufSize&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> friend class OSCL_String<code> [friend]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="oscl__string__containers_8h-source.html">oscl_string_containers.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>