doc/oscl_html/classOSCL__StackString.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>oscl: OSCL_StackString&lt; MaxBufSize &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>OSCL_StackString&lt; MaxBufSize &gt; Class Template Reference<br/>
<small>
[<a class="el" href="group__osclutil.html">OSCL Util</a>]</small>
</h1><!-- doxytag: class="OSCL_StackString" --><!-- doxytag: inherits="OSCL_String" -->
<p><code>#include &lt;<a class="el" href="oscl__string__containers_8h_source.html">oscl_string_containers.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for OSCL_StackString&lt; MaxBufSize &gt;:</div>
<div class="dynsection">
 <div class="center">
  <img src="classOSCL__StackString.png" usemap="#OSCL_StackString&lt; MaxBufSize &gt;_map" alt=""/>
  <map id="OSCL_StackString&lt; MaxBufSize &gt;_map" name="OSCL_StackString&lt; MaxBufSize &gt;_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>
 </div>
</div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classOSCL__String.html#af7dea5502bbb5f76c4680a06e4d8f143">OSCL_String::chartype</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOSCL__StackString.html#a8e1d8f3045ec166b37949b25e7c271b2">chartype</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__osclutil.html#gaf6a637a78b88f95b237198d9b90e52b5">TOSCL_StringOp</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOSCL__StackString.html#a733a45c8c6e85f0326b8c638653e4dae">optype</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classOSCL__wString.html#a9bb4700674b347022ae5d1757e64c450">OSCL_wString::chartype</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOSCL__StackString.html#aab97694107ac4c103b240a6fca58a822">other_chartype</a></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclutil.html#ga2a6e29cd31e9c8e7e05fd67ddf394021">OSCL_StackString</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclutil.html#gaba029a99c817efe565e92f3746a09b81">OSCL_StackString</a> (const <a class="el" href="classOSCL__StackString.html">OSCL_StackString</a> &amp;src)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclutil.html#gaff7d5a906900288b52f6d548a7bc2524">OSCL_StackString</a> (const <a class="el" href="classOSCL__String.html">OSCL_String</a> &amp;src)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclutil.html#ga659ce824b7c0e9a14f8cdb43afdf44b7">OSCL_StackString</a> (const <a class="el" href="classOSCL__StackString.html#a8e1d8f3045ec166b37949b25e7c271b2">chartype</a> *cstr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclutil.html#ga6c585f8372e95b66a069ffdc573376ed">OSCL_StackString</a> (const <a class="el" href="classOSCL__StackString.html#a8e1d8f3045ec166b37949b25e7c271b2">chartype</a> *buf, uint32 length)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclutil.html#gaef539fe8115df249fcef5353323f4d25">~OSCL_StackString</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclutil.html#ga36c27f2e1df71f676aed84a7826bc368">get_size</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclutil.html#ga43f087fdb217684291a95396b5e6ec8e">get_maxsize</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classOSCL__StackString.html#a8e1d8f3045ec166b37949b25e7c271b2">chartype</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclutil.html#ga7edaa64aa9084df2bf0709af553eed5c">get_cstr</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOSCL__StackString.html#a8e1d8f3045ec166b37949b25e7c271b2">chartype</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclutil.html#gad2d151b8a7c852dc9545f9a50bc3f7cb">get_str</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOSCL__StackString.html">OSCL_StackString</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclutil.html#ga64027bb5048d99683581213888f18261">operator=</a> (const <a class="el" href="classOSCL__StackString.html">OSCL_StackString</a> &amp;src)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOSCL__StackString.html">OSCL_StackString</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclutil.html#ga442431fe478aff0a612e2456c22f9ff7">operator=</a> (const <a class="el" href="classOSCL__String.html">OSCL_String</a> &amp;src)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOSCL__StackString.html">OSCL_StackString</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclutil.html#ga5fd72bb366b64792ced9be446dae2b9e">operator=</a> (const <a class="el" href="classOSCL__StackString.html#a8e1d8f3045ec166b37949b25e7c271b2">chartype</a> *cstr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclutil.html#ga89e3172b7f030428f844c7669c409934">set</a> (const <a class="el" href="classOSCL__StackString.html#a8e1d8f3045ec166b37949b25e7c271b2">chartype</a> *buf, uint32 length)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclutil.html#gac1fce846d23997ce29719d1d114e79e8">set</a> (const <a class="el" href="classOSCL__StackString.html#aab97694107ac4c103b240a6fca58a822">other_chartype</a> *buf, <a class="el" href="group__osclutil.html#gaf6a637a78b88f95b237198d9b90e52b5">optype</a> op)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclutil.html#gae77822613eed449cca4375225076b6e7">set</a> (const <a class="el" href="classOSCL__StackString.html#aab97694107ac4c103b240a6fca58a822">other_chartype</a> *buf, uint32 length, <a class="el" href="group__osclutil.html#gaf6a637a78b88f95b237198d9b90e52b5">optype</a> op)</td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOSCL__StackString.html#aa839ab3a00a9cad517aeaa26b6c1b85b">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>

<p><a class="el" href="classOSCL__StackString.html">OSCL_StackString</a> is a simple string class, compatible with regular character array strings.</p>
<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.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>C,:</em>&nbsp;</td><td>type of character. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>MaxBufSize,:</em>&nbsp;</td><td>maximum string length not including null terminator. </td></tr>
  </table>
  </dd>
</dl>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a8e1d8f3045ec166b37949b25e7c271b2"></a><!-- doxytag: member="OSCL_StackString::chartype" ref="a8e1d8f3045ec166b37949b25e7c271b2" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;uint32 MaxBufSize&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="classOSCL__String.html#af7dea5502bbb5f76c4680a06e4d8f143">OSCL_String::chartype</a> <a class="el" href="classOSCL__StackString.html">OSCL_StackString</a>&lt; MaxBufSize &gt;::<a class="el" href="classOSCL__StackString.html#a8e1d8f3045ec166b37949b25e7c271b2">chartype</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Reimplemented from <a class="el" href="classOSCL__String.html#af7dea5502bbb5f76c4680a06e4d8f143">OSCL_String</a>.</p>

</div>
</div>
<a class="anchor" id="a733a45c8c6e85f0326b8c638653e4dae"></a><!-- doxytag: member="OSCL_StackString::optype" ref="a733a45c8c6e85f0326b8c638653e4dae" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;uint32 MaxBufSize&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="group__osclutil.html#gaf6a637a78b88f95b237198d9b90e52b5">TOSCL_StringOp</a> <a class="el" href="classOSCL__StackString.html">OSCL_StackString</a>&lt; MaxBufSize &gt;::<a class="el" href="group__osclutil.html#gaf6a637a78b88f95b237198d9b90e52b5">optype</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="aab97694107ac4c103b240a6fca58a822"></a><!-- doxytag: member="OSCL_StackString::other_chartype" ref="aab97694107ac4c103b240a6fca58a822" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;uint32 MaxBufSize&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="classOSCL__wString.html#a9bb4700674b347022ae5d1757e64c450">OSCL_wString::chartype</a> <a class="el" href="classOSCL__StackString.html">OSCL_StackString</a>&lt; MaxBufSize &gt;::<a class="el" href="classOSCL__StackString.html#aab97694107ac4c103b240a6fca58a822">other_chartype</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="aa839ab3a00a9cad517aeaa26b6c1b85b"></a><!-- doxytag: member="OSCL_StackString::OSCL_String" ref="aa839ab3a00a9cad517aeaa26b6c1b85b" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;uint32 MaxBufSize&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">friend class <a class="el" href="classOSCL__String.html">OSCL_String</a><code> [friend]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<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></li>
</ul>
</div>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
<address style="align: left;"><small>Posting Version: CORE_9.004.1.1 </small>
</small></address>
</body>
</html>