blob: 98af1e50a3c47e4f4c51c1000f04cd99e1e874f7 [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>OsclBinIStream 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>OsclBinIStream Class Reference<br>
<small>
[<a class="el" href="group__osclutil.html">OSCL Util</a>]</small>
</h1><code>#include &lt;<a class="el" href="oscl__bin__stream_8h-source.html">oscl_bin_stream.h</a>&gt;</code>
<p>
<p>Inheritance diagram for OsclBinIStream:
<p><center><img src="classOsclBinIStream.png" usemap="#OsclBinIStream_map" border="0" alt=""></center>
<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>
<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="classOsclBinIStream.html#a0">OsclBinIStream</a> ()</td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classOsclBinIStream.html#a1">~OsclBinIStream</a> ()</td></tr>
<tr><td nowrap align=right valign=top>uint8&nbsp;</td><td valign=bottom><a class="el" href="classOsclBinIStream.html#a2">Read_uint8</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>This method reads an unsigned short from the stream.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>OsclBinIStream &amp;&nbsp;</td><td valign=bottom><a class="el" href="classOsclBinIStream.html#a3">get</a> (int8 *data, int32 size)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>This method reads 'length' number of bytes from the stream and places them in 'data'.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="OsclBinIStream::OsclBinIStream"></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" nowrap valign="top"> OsclBinIStream::OsclBinIStream </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="OsclBinIStream::~OsclBinIStream"></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" nowrap valign="top"> OsclBinIStream::~OsclBinIStream </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>
<hr><h2>Member Function Documentation</h2>
<a name="a3" doxytag="OsclBinIStream::get"></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" nowrap valign="top"> OsclBinIStream&amp; OsclBinIStream::get </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">int8 *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>data</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int32&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>size</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This method reads 'length' number of bytes from the stream and places them in 'data'.
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><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><em>size</em>&nbsp;</td><td>
is the number of bytes to read </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a2" doxytag="OsclBinIStream::Read_uint8"></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" nowrap valign="top"> uint8 OsclBinIStream::Read_uint8 </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></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This method reads an unsigned short from the stream.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
Unsigned short read from the stream. </dl> </td>
</tr>
</table>
<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></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>