blob: e77b17802ce68716e79b47994e45f0e0e96057bd [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> TemplateOsclNameString&lt; __len &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>OsclNameString&lt; __len &gt; Class Template Reference<br>
<small>
[<a class="el" href="group__osclerror.html">OSCL Error</a>]</small>
</h1><code>#include &lt;<a class="el" href="oscl__namestring_8h-source.html">oscl_namestring.h</a>&gt;</code>
<p>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></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="classOsclNameString.html#a0">OsclNameString</a> ()</td></tr>
<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>
<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>
<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>
<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>
<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>
<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>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;int __len&gt;<br>
class OsclNameString&lt; __len &gt;</h3>
Name string class appropriate for passing short constant ASCII strings around. All strings are automatically truncated and null-terminated.
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="OsclNameString::OsclNameString"></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;int __len&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> OsclNameString&lt; __len &gt;::OsclNameString </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> [inline]</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="a1" doxytag="OsclNameString::OsclNameString"></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;int __len&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> OsclNameString&lt; __len &gt;::OsclNameString </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const char&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>a</em>[] </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline]</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="a2" doxytag="OsclNameString::OsclNameString"></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;int __len&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> OsclNameString&lt; __len &gt;::OsclNameString </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">uint8 *&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>a</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline]</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="a6" doxytag="OsclNameString::MaxLen"></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;int __len&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> int32 OsclNameString&lt; __len &gt;::MaxLen </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> const<code> [inline]</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="a4" doxytag="OsclNameString::Set"></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;int __len&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> void OsclNameString&lt; __len &gt;::Set </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const char&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>a</em>[] </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline]</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="a3" doxytag="OsclNameString::Set"></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;int __len&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> void OsclNameString&lt; __len &gt;::Set </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">uint8 *&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>a</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set 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>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>a</em>&nbsp;</td><td>
(input param): null-terminated character string. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a5" doxytag="OsclNameString::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" colspan="4">
template&lt;int __len&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> uint8* OsclNameString&lt; __len &gt;::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> const<code> [inline]</code></td>
</tr>
</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__namestring_8h-source.html">oscl_namestring.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>