aboutsummaryrefslogtreecommitdiff
path: root/doc/oscl_html/classOsclBinIStream.html
blob: 1a08b690ba4efc71be0bc86f57096c0517c2c969 (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
<!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: OsclBinIStream 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><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>OsclBinIStream Class Reference<br/>
<small>
[<a class="el" href="group__osclutil.html">OSCL Util</a>]</small>
</h1><!-- doxytag: class="OsclBinIStream" --><!-- doxytag: inherits="OsclBinStream" -->
<p><code>#include &lt;<a class="el" href="oscl__bin__stream_8h_source.html">oscl_bin_stream.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for OsclBinIStream:</div>
<div class="dynsection">
 <div class="center">
  <img src="classOsclBinIStream.png" usemap="#OsclBinIStream_map" alt=""/>
  <map id="OsclBinIStream_map" name="OsclBinIStream_map">
<area href="classOsclBinStream.html" alt="OsclBinStream" shape="rect" coords="86,0,249,24"/>
<area href="classOsclBinIStreamBigEndian.html" alt="OsclBinIStreamBigEndian" shape="rect" coords="0,112,163,136"/>
<area href="classOsclBinIStreamLittleEndian.html" alt="OsclBinIStreamLittleEndian" shape="rect" coords="173,112,336,136"/>
</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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclBinIStream.html#a6635e10a9e9044698840930a9893847f">OsclBinIStream</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclBinIStream.html#a9886c576630091cd9d15acdfee19e04e">~OsclBinIStream</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclBinIStream.html#aa8726b4e5e383096d8ae39f0077840ee">Read_uint8</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method reads an unsigned short from the stream.  <a href="#aa8726b4e5e383096d8ae39f0077840ee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOsclBinIStream.html">OsclBinIStream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclBinIStream.html#a0338b7300838a27873c23397a036ed4c">get</a> (int8 *data, int32 size)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method reads 'length' number of bytes from the stream and places them in 'data'.  <a href="#a0338b7300838a27873c23397a036ed4c"></a><br/></td></tr>
</table>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a6635e10a9e9044698840930a9893847f"></a><!-- doxytag: member="OsclBinIStream::OsclBinIStream" ref="a6635e10a9e9044698840930a9893847f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OsclBinIStream::OsclBinIStream </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="a9886c576630091cd9d15acdfee19e04e"></a><!-- doxytag: member="OsclBinIStream::~OsclBinIStream" ref="a9886c576630091cd9d15acdfee19e04e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OsclBinIStream::~OsclBinIStream </td>
          <td>(</td>
          <td class="paramname"></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="a0338b7300838a27873c23397a036ed4c"></a><!-- doxytag: member="OsclBinIStream::get" ref="a0338b7300838a27873c23397a036ed4c" args="(int8 *data, int32 size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classOsclBinIStream.html">OsclBinIStream</a>&amp; OsclBinIStream::get </td>
          <td>(</td>
          <td class="paramtype">int8 *&nbsp;</td>
          <td class="paramname"> <em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int32&nbsp;</td>
          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>This method reads 'length' number of bytes from the stream and places them in 'data'. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>is a pointer to the place to store the bytes read </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>is the number of bytes to read </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="aa8726b4e5e383096d8ae39f0077840ee"></a><!-- doxytag: member="OsclBinIStream::Read_uint8" ref="aa8726b4e5e383096d8ae39f0077840ee" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8 OsclBinIStream::Read_uint8 </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>This method reads an unsigned short from the stream. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Unsigned short read from the stream. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="oscl__bin__stream_8h_source.html">oscl_bin_stream.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>