PageRenderTime 23ms CodeModel.GetById 14ms app.highlight 5ms RepoModel.GetById 1ms app.codeStats 0ms

/xbmc/visualizations/Vortex/angelscript/docs/manual/classas_i_binary_stream.html

http://github.com/xbmc/xbmc
HTML | 105 lines | 99 code | 5 blank | 1 comment | 0 complexity | 5d2739b3394d534ee20d58dac3c6c16f MD5 | raw file
  1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
  3<title>AngelScript: asIBinaryStream Class Reference</title>
  4<link href="tabs.css" rel="stylesheet" type="text/css">
  5<link href="doxygen.css" rel="stylesheet" type="text/css">
  6</head><body>
  7<!-- Generated by Doxygen 1.5.9 -->
  8<div class="contents">
  9<h1>asIBinaryStream Class Reference</h1><!-- doxytag: class="asIBinaryStream" -->A binary stream interface.  
 10<a href="#_details">More...</a>
 11<p>
 12
 13<p>
 14<a href="classas_i_binary_stream-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
 15<tr><td></td></tr>
 16<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
 17<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_binary_stream.html#b69b772db0a4157a842d90070e6fa1dc">Read</a> (void *ptr, <a class="el" href="angelscript_8h.html#c8186f029686800b7ce36bde4a55c815">asUINT</a> size)=0</td></tr>
 18
 19<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read size bytes from the stream into the memory pointed to by ptr.  <a href="#b69b772db0a4157a842d90070e6fa1dc"></a><br></td></tr>
 20<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_binary_stream.html#1fce5bbea004d6b2705f9eefae1a3770">Write</a> (const void *ptr, <a class="el" href="angelscript_8h.html#c8186f029686800b7ce36bde4a55c815">asUINT</a> size)=0</td></tr>
 21
 22<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write size bytes to the stream from the memory pointed to by ptr.  <a href="#1fce5bbea004d6b2705f9eefae1a3770"></a><br></td></tr>
 23</table>
 24<hr><a name="_details"></a><h2>Detailed Description</h2>
 25This interface is used when storing compiled bytecode to disk or memory, and then loading it into the engine again.<p>
 26<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classas_i_script_module.html#3ce3eae66f22733d83b31f1646cdd92c">asIScriptModule::SaveByteCode</a>, <a class="el" href="classas_i_script_module.html#2cf2e0fa7de8a14034eb31aa3edecbd0">asIScriptModule::LoadByteCode</a> </dd></dl>
 27<hr><h2>Member Function Documentation</h2>
 28<a class="anchor" name="b69b772db0a4157a842d90070e6fa1dc"></a><!-- doxytag: member="asIBinaryStream::Read" ref="b69b772db0a4157a842d90070e6fa1dc" args="(void *ptr, asUINT size)=0" -->
 29<div class="memitem">
 30<div class="memproto">
 31      <table class="memname">
 32        <tr>
 33          <td class="memname">virtual void asIBinaryStream::Read           </td>
 34          <td>(</td>
 35          <td class="paramtype">void *&nbsp;</td>
 36          <td class="paramname"> <em>ptr</em>, </td>
 37        </tr>
 38        <tr>
 39          <td class="paramkey"></td>
 40          <td></td>
 41          <td class="paramtype"><a class="el" href="angelscript_8h.html#c8186f029686800b7ce36bde4a55c815">asUINT</a>&nbsp;</td>
 42          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
 43        </tr>
 44        <tr>
 45          <td></td>
 46          <td>)</td>
 47          <td></td><td></td><td><code> [pure virtual]</code></td>
 48        </tr>
 49      </table>
 50</div>
 51<div class="memdoc">
 52
 53<p>
 54<dl compact><dt><b>Parameters:</b></dt><dd>
 55  <table border="0" cellspacing="2" cellpadding="0">
 56    <tr><td valign="top"><tt>[out]</tt>&nbsp;</td><td valign="top"><em>ptr</em>&nbsp;</td><td>A pointer to the buffer that will receive the data. </td></tr>
 57    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>size</em>&nbsp;</td><td>The number of bytes to read.</td></tr>
 58  </table>
 59</dl>
 60Read <em>size</em> bytes from the data stream into the memory pointed to by <em>ptr</em>. 
 61</div>
 62</div><p>
 63<a class="anchor" name="1fce5bbea004d6b2705f9eefae1a3770"></a><!-- doxytag: member="asIBinaryStream::Write" ref="1fce5bbea004d6b2705f9eefae1a3770" args="(const void *ptr, asUINT size)=0" -->
 64<div class="memitem">
 65<div class="memproto">
 66      <table class="memname">
 67        <tr>
 68          <td class="memname">virtual void asIBinaryStream::Write           </td>
 69          <td>(</td>
 70          <td class="paramtype">const void *&nbsp;</td>
 71          <td class="paramname"> <em>ptr</em>, </td>
 72        </tr>
 73        <tr>
 74          <td class="paramkey"></td>
 75          <td></td>
 76          <td class="paramtype"><a class="el" href="angelscript_8h.html#c8186f029686800b7ce36bde4a55c815">asUINT</a>&nbsp;</td>
 77          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
 78        </tr>
 79        <tr>
 80          <td></td>
 81          <td>)</td>
 82          <td></td><td></td><td><code> [pure virtual]</code></td>
 83        </tr>
 84      </table>
 85</div>
 86<div class="memdoc">
 87
 88<p>
 89<dl compact><dt><b>Parameters:</b></dt><dd>
 90  <table border="0" cellspacing="2" cellpadding="0">
 91    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>ptr</em>&nbsp;</td><td>A pointer to the buffer that the data should written from. </td></tr>
 92    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>size</em>&nbsp;</td><td>The number of bytes to write.</td></tr>
 93  </table>
 94</dl>
 95Write <em>size</em> bytes to the data stream from the memory pointed to by <em>ptr</em>. 
 96</div>
 97</div><p>
 98<hr>The documentation for this class was generated from the following file:<ul>
 99<li><a class="el" href="angelscript_8h.html">angelscript.h</a></ul>
100</div>
101<hr size="1"><address style="text-align: right;"><small>Generated on Wed Dec 16 19:34:51 2009 for AngelScript by&nbsp;
102<a href="http://www.doxygen.org/index.html">
103<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
104</body>
105</html>