aboutsummaryrefslogtreecommitdiff
path: root/doc/oscl_html/classOsclNameString.html
blob: c77185f119d38b160218858a3bdba128c1732272 (plain)
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
<!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: OsclNameString&lt; __len &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>OsclNameString&lt; __len &gt; Class Template Reference<br/>
<small>
[<a class="el" href="group__osclerror.html">OSCL Error</a>]</small>
</h1><!-- doxytag: class="OsclNameString" -->
<p><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 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="classOsclNameString.html#abe6b9eb132dd33bc117d1c63ac1066ce">OsclNameString</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclNameString.html#a051e8a7c50f981339efd301a8ff42c7d">OsclNameString</a> (const char a[])</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclNameString.html#af5966c22a33daf7b25bcc68cb29c71ad">OsclNameString</a> (uint8 *a)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclNameString.html#a9c04098b5f8f316ed9dc47ae136f0aac">Set</a> (uint8 *a)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclNameString.html#a60b14913b951ad08b9542a69c930d5e2">Set</a> (const char a[])</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8 *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclNameString.html#a5d435db47b92996f464e607bdd11fa0b">Str</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclNameString.html#a3347af1dad890cfa0fca094d1099a1a0">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>

<p>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 class="anchor" id="abe6b9eb132dd33bc117d1c63ac1066ce"></a><!-- doxytag: member="OsclNameString::OsclNameString" ref="abe6b9eb132dd33bc117d1c63ac1066ce" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int __len&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classOsclNameString.html">OsclNameString</a>&lt; __len &gt;::<a class="el" href="classOsclNameString.html">OsclNameString</a> </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a051e8a7c50f981339efd301a8ff42c7d"></a><!-- doxytag: member="OsclNameString::OsclNameString" ref="a051e8a7c50f981339efd301a8ff42c7d" args="(const char a[])" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int __len&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classOsclNameString.html">OsclNameString</a>&lt; __len &gt;::<a class="el" href="classOsclNameString.html">OsclNameString</a> </td>
          <td>(</td>
          <td class="paramtype">const char&nbsp;</td>
          <td class="paramname"> <em>a</em>[]</td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="af5966c22a33daf7b25bcc68cb29c71ad"></a><!-- doxytag: member="OsclNameString::OsclNameString" ref="af5966c22a33daf7b25bcc68cb29c71ad" args="(uint8 *a)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int __len&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classOsclNameString.html">OsclNameString</a>&lt; __len &gt;::<a class="el" href="classOsclNameString.html">OsclNameString</a> </td>
          <td>(</td>
          <td class="paramtype">uint8 *&nbsp;</td>
          <td class="paramname"> <em>a</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3347af1dad890cfa0fca094d1099a1a0"></a><!-- doxytag: member="OsclNameString::MaxLen" ref="a3347af1dad890cfa0fca094d1099a1a0" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int __len&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">int32 <a class="el" href="classOsclNameString.html">OsclNameString</a>&lt; __len &gt;::MaxLen </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a60b14913b951ad08b9542a69c930d5e2"></a><!-- doxytag: member="OsclNameString::Set" ref="a60b14913b951ad08b9542a69c930d5e2" args="(const char a[])" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int __len&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classOsclNameString.html">OsclNameString</a>&lt; __len &gt;::Set </td>
          <td>(</td>
          <td class="paramtype">const char&nbsp;</td>
          <td class="paramname"> <em>a</em>[]</td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a9c04098b5f8f316ed9dc47ae136f0aac"></a><!-- doxytag: member="OsclNameString::Set" ref="a9c04098b5f8f316ed9dc47ae136f0aac" args="(uint8 *a)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int __len&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classOsclNameString.html">OsclNameString</a>&lt; __len &gt;::Set </td>
          <td>(</td>
          <td class="paramtype">uint8 *&nbsp;</td>
          <td class="paramname"> <em>a</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Set the string to the input value. The string will be truncated to fit the storage class and automatically null-terminated.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>a</em>&nbsp;</td><td>(input param): null-terminated character string. </td></tr>
  </table>
  </dd>
</dl>

<p>Referenced by <a class="el" href="oscl__udp__socket_8h_source.html#l00085">OsclUDPSocketI::BindAsync()</a>, <a class="el" href="oscl__tcp__socket_8h_source.html#l00144">OsclTCPSocketI::BindAsync()</a>, <a class="el" href="oscl__namestring_8h_source.html#l00035">OsclNameString&lt; PVNETWORKADDRESS_LEN &gt;::OsclNameString()</a>, <a class="el" href="oscl__dns__param_8h_source.html#l00085">GetHostByNameParam::PersistHostAddress()</a>, and <a class="el" href="oscl__namestring_8h_source.html#l00073">OsclNameString&lt; PVNETWORKADDRESS_LEN &gt;::Set()</a>.</p>

</div>
</div>
<a class="anchor" id="a5d435db47b92996f464e607bdd11fa0b"></a><!-- doxytag: member="OsclNameString::Str" ref="a5d435db47b92996f464e607bdd11fa0b" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int __len&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">uint8* <a class="el" href="classOsclNameString.html">OsclNameString</a>&lt; __len &gt;::Str </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Referenced by <a class="el" href="oscl__udp__socket_8h_source.html#l00085">OsclUDPSocketI::BindAsync()</a>, <a class="el" href="oscl__tcp__socket_8h_source.html#l00144">OsclTCPSocketI::BindAsync()</a>, <a class="el" href="oscl__dns__param_8h_source.html#l00096">GetHostByNameParam::canPersistMoreHostAddresses()</a>, <a class="el" href="oscl__socket__types_8h_source.html#l00143">OsclNetworkAddress::operator==()</a>, and <a class="el" href="oscl__dns__param_8h_source.html#l00085">GetHostByNameParam::PersistHostAddress()</a>.</p>

</div>
</div>
<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></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.005.1.1 </small>
</small></address>
</body>
</html>