doc/pv2way_html/classCPVUserInputAlphanumeric.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
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

<!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>pv2way_engine: CPVUserInputAlphanumeric Class 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 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>CPVUserInputAlphanumeric Class Reference</h1><!-- doxytag: class="CPVUserInputAlphanumeric" --><!-- doxytag: inherits="CPVUserInput" -->
<p><code>#include &lt;<a class="el" href="pv__2way__h324m__types_8h_source.html">pv_2way_h324m_types.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for CPVUserInputAlphanumeric:</div>
<div class="dynsection">
 <div class="center">
  <img src="classCPVUserInputAlphanumeric.png" usemap="#CPVUserInputAlphanumeric_map" alt=""/>
  <map id="CPVUserInputAlphanumeric_map" name="CPVUserInputAlphanumeric_map">
<area href="classCPVUserInput.html" alt="CPVUserInput" shape="rect" coords="0,0,169,24"/>
</map>
 </div>
</div>
<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">OSCL_IMPORT_REF&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPVUserInputAlphanumeric.html#ab2e4a42d6e9c85541b032fcf8e6f0dec">CPVUserInputAlphanumeric</a> (uint8 *apInput, uint16 aLen)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPVUserInputAlphanumeric.html#adc8c3baf8fb5f88a571a352f109aa946">~CPVUserInputAlphanumeric</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF <a class="el" href="pv__2way__h324m__types_8h.html#af5f88d26becc61f93f23d5022152fe39">PV2WayUserInputType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPVUserInputAlphanumeric.html#a3912fc48f28d82a8df1cd181281d0e39">GetType</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF uint8 *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPVUserInputAlphanumeric.html#a56161f55b7274afe7d97a497be9fdad3">GetInput</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF uint16&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPVUserInputAlphanumeric.html#af871061eef0398650323f4d32e56aa89">GetLength</a> ()</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8 *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPVUserInputAlphanumeric.html#a5097735233f248b9f36ffb1836cee73b">ipInput</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint16&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPVUserInputAlphanumeric.html#a899a13a57447430abe31ea8d806ee621">iLength</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classCPVUserInputAlphanumeric.html">CPVUserInputAlphanumeric</a> Class</p>
<p><a class="el" href="classCPVUserInputAlphanumeric.html">CPVUserInputAlphanumeric</a> class contains an alphanumeric string from an H.245 UserInputIndication message. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ab2e4a42d6e9c85541b032fcf8e6f0dec"></a><!-- doxytag: member="CPVUserInputAlphanumeric::CPVUserInputAlphanumeric" ref="ab2e4a42d6e9c85541b032fcf8e6f0dec" args="(uint8 *apInput, uint16 aLen)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF CPVUserInputAlphanumeric::CPVUserInputAlphanumeric </td>
          <td>(</td>
          <td class="paramtype">uint8 *&nbsp;</td>
          <td class="paramname"> <em>apInput</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16&nbsp;</td>
          <td class="paramname"> <em>aLen</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructor of <a class="el" href="classCPVUserInputAlphanumeric.html">CPVUserInputAlphanumeric</a> class.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>apInput</em>&nbsp;</td><td>The input alphanumeric string (T.50 encoded). </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>aLen</em>&nbsp;</td><td>The lenght of alphanumeric string in bytes </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>none  This method can leave with one of the following error codes OsclErrGeneral memory copy failed </dd></dl>

</div>
</div>
<a class="anchor" id="adc8c3baf8fb5f88a571a352f109aa946"></a><!-- doxytag: member="CPVUserInputAlphanumeric::~CPVUserInputAlphanumeric" ref="adc8c3baf8fb5f88a571a352f109aa946" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF CPVUserInputAlphanumeric::~CPVUserInputAlphanumeric </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Destructor. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a56161f55b7274afe7d97a497be9fdad3"></a><!-- doxytag: member="CPVUserInputAlphanumeric::GetInput" ref="a56161f55b7274afe7d97a497be9fdad3" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF uint8* CPVUserInputAlphanumeric::GetInput </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the user input alphanumeric user input</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns pointer to alphanumeric user input. </dd></dl>

</div>
</div>
<a class="anchor" id="af871061eef0398650323f4d32e56aa89"></a><!-- doxytag: member="CPVUserInputAlphanumeric::GetLength" ref="af871061eef0398650323f4d32e56aa89" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF uint16 CPVUserInputAlphanumeric::GetLength </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the size of alphanumeric user input</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns size of alphanumeric user input. </dd></dl>

</div>
</div>
<a class="anchor" id="a3912fc48f28d82a8df1cd181281d0e39"></a><!-- doxytag: member="CPVUserInputAlphanumeric::GetType" ref="a3912fc48f28d82a8df1cd181281d0e39" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF <a class="el" href="pv__2way__h324m__types_8h.html#af5f88d26becc61f93f23d5022152fe39">PV2WayUserInputType</a> CPVUserInputAlphanumeric::GetType </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Virtual function to return the user input type </p>

<p>Implements <a class="el" href="classCPVUserInput.html#a2d9ffe661e7f9a2308b937a7d96e8a85">CPVUserInput</a>.</p>

</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a899a13a57447430abe31ea8d806ee621"></a><!-- doxytag: member="CPVUserInputAlphanumeric::iLength" ref="a899a13a57447430abe31ea8d806ee621" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint16 <a class="el" href="classCPVUserInputAlphanumeric.html#a899a13a57447430abe31ea8d806ee621">CPVUserInputAlphanumeric::iLength</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a5097735233f248b9f36ffb1836cee73b"></a><!-- doxytag: member="CPVUserInputAlphanumeric::ipInput" ref="a5097735233f248b9f36ffb1836cee73b" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8* <a class="el" href="classCPVUserInputAlphanumeric.html#a5097735233f248b9f36ffb1836cee73b">CPVUserInputAlphanumeric::ipInput</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The input alphanumeric string. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="pv__2way__h324m__types_8h_source.html">pv_2way_h324m_types.h</a></li>
</ul>
</div>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV2Way Engine</small>
<address style="align: left;"><small>Posting Version: CORE_9.002.1.1 </small>
</small></address>
</body>
</html>