• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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> TemplateOsclNameString&lt; __len &gt; 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> &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>
9<hr><h1>OsclNameString&lt; __len &gt; Class Template Reference<br>
10<small>
11[<a class="el" href="group__osclerror.html">OSCL Error</a>]</small>
12</h1><code>#include &lt;<a class="el" href="oscl__namestring_8h-source.html">oscl_namestring.h</a>&gt;</code>
13<p>
14<table border=0 cellpadding=0 cellspacing=0>
15<tr><td></td></tr>
16<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
17<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classOsclNameString.html#a0">OsclNameString</a> ()</td></tr>
18<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classOsclNameString.html#a1">OsclNameString</a> (const char a[])</td></tr>
19<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classOsclNameString.html#a2">OsclNameString</a> (uint8 *a)</td></tr>
20<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classOsclNameString.html#a3">Set</a> (uint8 *a)</td></tr>
21<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classOsclNameString.html#a4">Set</a> (const char a[])</td></tr>
22<tr><td nowrap align=right valign=top>uint8 *&nbsp;</td><td valign=bottom><a class="el" href="classOsclNameString.html#a5">Str</a> () const</td></tr>
23<tr><td nowrap align=right valign=top>int32&nbsp;</td><td valign=bottom><a class="el" href="classOsclNameString.html#a6">MaxLen</a> () const</td></tr>
24</table>
25<hr><a name="_details"></a><h2>Detailed Description</h2>
26<h3>template&lt;int __len&gt;<br>
27 class OsclNameString&lt; __len &gt;</h3>
28
29Name string class appropriate for passing short constant ASCII strings around. All strings are automatically truncated and null-terminated.
30<p>
31<hr><h2>Constructor &amp; Destructor Documentation</h2>
32<a name="a0" doxytag="OsclNameString::OsclNameString"></a><p>
33<table width="100%" cellpadding="2" cellspacing="0" border="0">
34  <tr>
35    <td class="md">
36      <table cellpadding="0" cellspacing="0" border="0">
37        <tr>
38          <td class="md" colspan="4">
39template&lt;int __len&gt; </td>
40        </tr>
41        <tr>
42          <td class="md" nowrap valign="top"> OsclNameString&lt; __len &gt;::OsclNameString </td>
43          <td class="md" valign="top">(&nbsp;</td>
44          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
45          <td class="md" valign="top">)&nbsp;</td>
46          <td class="md" nowrap><code> [inline]</code></td>
47        </tr>
48
49      </table>
50    </td>
51  </tr>
52</table>
53<table cellspacing=5 cellpadding=0 border=0>
54  <tr>
55    <td>
56      &nbsp;
57    </td>
58    <td>
59
60<p>
61    </td>
62  </tr>
63</table>
64<a name="a1" doxytag="OsclNameString::OsclNameString"></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" colspan="4">
71template&lt;int __len&gt; </td>
72        </tr>
73        <tr>
74          <td class="md" nowrap valign="top"> OsclNameString&lt; __len &gt;::OsclNameString </td>
75          <td class="md" valign="top">(&nbsp;</td>
76          <td class="md" nowrap valign="top">const char&nbsp;</td>
77          <td class="mdname1" valign="top" nowrap>&nbsp; <em>a</em>[]          </td>
78          <td class="md" valign="top">)&nbsp;</td>
79          <td class="md" nowrap><code> [inline]</code></td>
80        </tr>
81
82      </table>
83    </td>
84  </tr>
85</table>
86<table cellspacing=5 cellpadding=0 border=0>
87  <tr>
88    <td>
89      &nbsp;
90    </td>
91    <td>
92
93<p>
94    </td>
95  </tr>
96</table>
97<a name="a2" doxytag="OsclNameString::OsclNameString"></a><p>
98<table width="100%" cellpadding="2" cellspacing="0" border="0">
99  <tr>
100    <td class="md">
101      <table cellpadding="0" cellspacing="0" border="0">
102        <tr>
103          <td class="md" colspan="4">
104template&lt;int __len&gt; </td>
105        </tr>
106        <tr>
107          <td class="md" nowrap valign="top"> OsclNameString&lt; __len &gt;::OsclNameString </td>
108          <td class="md" valign="top">(&nbsp;</td>
109          <td class="md" nowrap valign="top">uint8 *&nbsp;</td>
110          <td class="mdname1" valign="top" nowrap>&nbsp; <em>a</em>          </td>
111          <td class="md" valign="top">)&nbsp;</td>
112          <td class="md" nowrap><code> [inline]</code></td>
113        </tr>
114
115      </table>
116    </td>
117  </tr>
118</table>
119<table cellspacing=5 cellpadding=0 border=0>
120  <tr>
121    <td>
122      &nbsp;
123    </td>
124    <td>
125
126<p>
127    </td>
128  </tr>
129</table>
130<hr><h2>Member Function Documentation</h2>
131<a name="a6" doxytag="OsclNameString::MaxLen"></a><p>
132<table width="100%" cellpadding="2" cellspacing="0" border="0">
133  <tr>
134    <td class="md">
135      <table cellpadding="0" cellspacing="0" border="0">
136        <tr>
137          <td class="md" colspan="4">
138template&lt;int __len&gt; </td>
139        </tr>
140        <tr>
141          <td class="md" nowrap valign="top"> int32 OsclNameString&lt; __len &gt;::MaxLen </td>
142          <td class="md" valign="top">(&nbsp;</td>
143          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
144          <td class="md" valign="top">)&nbsp;</td>
145          <td class="md" nowrap> const<code> [inline]</code></td>
146        </tr>
147
148      </table>
149    </td>
150  </tr>
151</table>
152<table cellspacing=5 cellpadding=0 border=0>
153  <tr>
154    <td>
155      &nbsp;
156    </td>
157    <td>
158
159<p>
160    </td>
161  </tr>
162</table>
163<a name="a4" doxytag="OsclNameString::Set"></a><p>
164<table width="100%" cellpadding="2" cellspacing="0" border="0">
165  <tr>
166    <td class="md">
167      <table cellpadding="0" cellspacing="0" border="0">
168        <tr>
169          <td class="md" colspan="4">
170template&lt;int __len&gt; </td>
171        </tr>
172        <tr>
173          <td class="md" nowrap valign="top"> void OsclNameString&lt; __len &gt;::Set </td>
174          <td class="md" valign="top">(&nbsp;</td>
175          <td class="md" nowrap valign="top">const char&nbsp;</td>
176          <td class="mdname1" valign="top" nowrap>&nbsp; <em>a</em>[]          </td>
177          <td class="md" valign="top">)&nbsp;</td>
178          <td class="md" nowrap><code> [inline]</code></td>
179        </tr>
180
181      </table>
182    </td>
183  </tr>
184</table>
185<table cellspacing=5 cellpadding=0 border=0>
186  <tr>
187    <td>
188      &nbsp;
189    </td>
190    <td>
191
192<p>
193    </td>
194  </tr>
195</table>
196<a name="a3" doxytag="OsclNameString::Set"></a><p>
197<table width="100%" cellpadding="2" cellspacing="0" border="0">
198  <tr>
199    <td class="md">
200      <table cellpadding="0" cellspacing="0" border="0">
201        <tr>
202          <td class="md" colspan="4">
203template&lt;int __len&gt; </td>
204        </tr>
205        <tr>
206          <td class="md" nowrap valign="top"> void OsclNameString&lt; __len &gt;::Set </td>
207          <td class="md" valign="top">(&nbsp;</td>
208          <td class="md" nowrap valign="top">uint8 *&nbsp;</td>
209          <td class="mdname1" valign="top" nowrap>&nbsp; <em>a</em>          </td>
210          <td class="md" valign="top">)&nbsp;</td>
211          <td class="md" nowrap><code> [inline]</code></td>
212        </tr>
213
214      </table>
215    </td>
216  </tr>
217</table>
218<table cellspacing=5 cellpadding=0 border=0>
219  <tr>
220    <td>
221      &nbsp;
222    </td>
223    <td>
224
225<p>
226Set the string to the input value. The string will be truncated to fit the storage class and automatically null-terminated.<dl compact><dt><b>Parameters: </b></dt><dd>
227<table border=0 cellspacing=2 cellpadding=0>
228<tr><td valign=top><em>a</em>&nbsp;</td><td>
229(input param): null-terminated character string. </td></tr>
230</table>
231</dl>    </td>
232  </tr>
233</table>
234<a name="a5" doxytag="OsclNameString::Str"></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" colspan="4">
241template&lt;int __len&gt; </td>
242        </tr>
243        <tr>
244          <td class="md" nowrap valign="top"> uint8* OsclNameString&lt; __len &gt;::Str </td>
245          <td class="md" valign="top">(&nbsp;</td>
246          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
247          <td class="md" valign="top">)&nbsp;</td>
248          <td class="md" nowrap> const<code> [inline]</code></td>
249        </tr>
250
251      </table>
252    </td>
253  </tr>
254</table>
255<table cellspacing=5 cellpadding=0 border=0>
256  <tr>
257    <td>
258      &nbsp;
259    </td>
260    <td>
261
262<p>
263    </td>
264  </tr>
265</table>
266<hr>The documentation for this class was generated from the following file:<ul>
267<li><a class="el" href="oscl__namestring_8h-source.html">oscl_namestring.h</a></ul>
268<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
269<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
270</small></address>
271</body>
272</html>
273