class_file_stream.html 65 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Torque2D Reference: FileStream Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr id="projectrow">
  24. <td id="projectalign">
  25. <div id="projectname">Torque2D Reference
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.9.8 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */
  48. </script>
  49. <div id="main-nav"></div>
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <div id="MSearchResults">
  59. <div class="SRPage">
  60. <div id="SRIndex">
  61. <div id="SRResults"></div>
  62. <div class="SRStatus" id="Loading">Loading...</div>
  63. <div class="SRStatus" id="Searching">Searching...</div>
  64. <div class="SRStatus" id="NoMatches">No Matches</div>
  65. </div>
  66. </div>
  67. </div>
  68. </div>
  69. </div><!-- top -->
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#pub-types">Public Types</a> &#124;
  73. <a href="#pub-methods">Public Member Functions</a> &#124;
  74. <a href="#pro-methods">Protected Member Functions</a> &#124;
  75. <a href="#pro-static-methods">Static Protected Member Functions</a> &#124;
  76. <a href="#pro-attribs">Protected Attributes</a> &#124;
  77. <a href="class_file_stream-members.html">List of all members</a> </div>
  78. <div class="headertitle"><div class="title">FileStream Class Reference</div></div>
  79. </div><!--header-->
  80. <div class="contents">
  81. <p><code>#include &lt;fileStream.h&gt;</code></p>
  82. <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  83. <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for FileStream:</div>
  84. <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
  85. </div>
  86. <div id="dynsection-0-content" class="dyncontent" style="display:none;">
  87. <div class="center">
  88. <img src="class_file_stream.png" usemap="#FileStream_map" alt=""/>
  89. <map id="FileStream_map" name="FileStream_map">
  90. <area href="class_stream.html" title="Base stream class for streaming data across a specific media." alt="Stream" shape="rect" coords="0,0,100,24"/>
  91. <area href="class_zip_1_1_zip_temp_stream.html" alt="ZipTempStream" shape="rect" coords="0,112,100,136"/>
  92. </map>
  93. </div></div>
  94. <table class="memberdecls">
  95. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
  96. Public Types</h2></td></tr>
  97. <tr class="memitem:ab22d35ed086a478dd91e93ac78037f40" id="r_ab22d35ed086a478dd91e93ac78037f40"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#ab22d35ed086a478dd91e93ac78037f40">AccessMode</a> { <a class="el" href="class_file_stream.html#ab22d35ed086a478dd91e93ac78037f40a809abe96853e69894bbf8e5730b31348">Read</a> = File::Read
  98. , <a class="el" href="class_file_stream.html#ab22d35ed086a478dd91e93ac78037f40aa56670174817e3fed92bfd8182d7c0d1">Write</a> = File::Write
  99. , <a class="el" href="class_file_stream.html#ab22d35ed086a478dd91e93ac78037f40a3c4d2d19c91b345c33a83ca9f551f4e1">ReadWrite</a> = File::ReadWrite
  100. , <a class="el" href="class_file_stream.html#ab22d35ed086a478dd91e93ac78037f40a41d36294f7608c7e5565aee5aee6dcf7">WriteAppend</a> = File::WriteAppend
  101. }</td></tr>
  102. <tr class="separator:ab22d35ed086a478dd91e93ac78037f40"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a16af7b253440dadd46a80a4b9fddba4d" id="r_a16af7b253440dadd46a80a4b9fddba4d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom">{ <a class="el" href="class_file_stream.html#a16af7b253440dadd46a80a4b9fddba4da1a63387ea87dae07937bf38548748733">BUFFER_SIZE</a> = 8 * 1024
  104. , <a class="el" href="class_file_stream.html#a16af7b253440dadd46a80a4b9fddba4da4c9e74658923bde10a0f25eaf32a5be2">BUFFER_INVALID</a> = 0xffffffff
  105. }</td></tr>
  106. <tr class="separator:a16af7b253440dadd46a80a4b9fddba4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="inherit_header pub_types_class_stream"><td colspan="2" onclick="javascript:toggleInherit('pub_types_class_stream')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="class_stream.html">Stream</a></td></tr>
  108. <tr class="memitem:a67a0db04d321a74b7e7fcfd3f1a3f70b inherit pub_types_class_stream" id="r_a67a0db04d321a74b7e7fcfd3f1a3f70b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> { <br />
  109. &#160;&#160;<a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba06d32f047358de4e6a30c28046f4688e">Ok</a> = 0
  110. , <a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba53ea0cae152133005a5dbe9a1329765c">IOError</a>
  111. , <a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70bae4953b2aea10c683c1f4990a11e01d4d">EOS</a>
  112. , <a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70baa359c7ce2440768125c74d431817548a">IllegalCall</a>
  113. , <br />
  114. &#160;&#160;<a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba30c0b4dad1e3a3b93f822b9cef26244b">Closed</a>
  115. , <a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba36b13bee92e122caddcb8abefb6eec31">UnknownError</a>
  116. <br />
  117. }</td></tr>
  118. <tr class="memdesc:a67a0db04d321a74b7e7fcfd3f1a3f70b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Status constantants for the stream. <a href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">More...</a><br /></td></tr>
  119. <tr class="separator:a67a0db04d321a74b7e7fcfd3f1a3f70b inherit pub_types_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a4171335401279aad7e5a463349c093c6 inherit pub_types_class_stream" id="r_a4171335401279aad7e5a463349c093c6"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a4171335401279aad7e5a463349c093c6">Capability</a> { <a class="el" href="class_stream.html#a4171335401279aad7e5a463349c093c6a8b38409f320f118d34803056f9c4ea3b">StreamWrite</a> = BIT(0)
  121. , <a class="el" href="class_stream.html#a4171335401279aad7e5a463349c093c6a086614a0f074a4c74b661a636d915a6b">StreamRead</a> = BIT(1)
  122. , <a class="el" href="class_stream.html#a4171335401279aad7e5a463349c093c6ab1207c45b01a44c072b04ccaff4a241d">StreamPosition</a> = BIT(2)
  123. }</td></tr>
  124. <tr class="separator:a4171335401279aad7e5a463349c093c6 inherit pub_types_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. </table><table class="memberdecls">
  126. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  127. Public Member Functions</h2></td></tr>
  128. <tr class="memitem:aa4f8549edc02f08b2287f3f472fa4ed6" id="r_aa4f8549edc02f08b2287f3f472fa4ed6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#aa4f8549edc02f08b2287f3f472fa4ed6">FileStream</a> ()</td></tr>
  129. <tr class="separator:aa4f8549edc02f08b2287f3f472fa4ed6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a19e0b2bee0e3bc81ea6e6ba6c6a44134" id="r_a19e0b2bee0e3bc81ea6e6ba6c6a44134"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#a19e0b2bee0e3bc81ea6e6ba6c6a44134">~FileStream</a> ()</td></tr>
  131. <tr class="separator:a19e0b2bee0e3bc81ea6e6ba6c6a44134"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:ac9b5a7153e82dc56e88e5d427de6d8b7" id="r_ac9b5a7153e82dc56e88e5d427de6d8b7"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#ac9b5a7153e82dc56e88e5d427de6d8b7">hasCapability</a> (const <a class="el" href="class_stream.html#a4171335401279aad7e5a463349c093c6">Capability</a> i_cap) const</td></tr>
  133. <tr class="memdesc:ac9b5a7153e82dc56e88e5d427de6d8b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks to see if this stream has the capability of a given function. <br /></td></tr>
  134. <tr class="separator:ac9b5a7153e82dc56e88e5d427de6d8b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:ae91252bdbffcafaefaa6edec813a3c1e" id="r_ae91252bdbffcafaefaa6edec813a3c1e"><td class="memItemLeft" align="right" valign="top">virtual U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#ae91252bdbffcafaefaa6edec813a3c1e">getPosition</a> () const</td></tr>
  136. <tr class="memdesc:ae91252bdbffcafaefaa6edec813a3c1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the position in the stream. <br /></td></tr>
  137. <tr class="separator:ae91252bdbffcafaefaa6edec813a3c1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a75d0bd9d352b99b88457e772a43df38d" id="r_a75d0bd9d352b99b88457e772a43df38d"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#a75d0bd9d352b99b88457e772a43df38d">setPosition</a> (const U32 i_newPosition)</td></tr>
  139. <tr class="memdesc:a75d0bd9d352b99b88457e772a43df38d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the position of the stream. Returns if the new position is valid or not. <br /></td></tr>
  140. <tr class="separator:a75d0bd9d352b99b88457e772a43df38d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:aaa67310324a7402bcca80535b361e287" id="r_aaa67310324a7402bcca80535b361e287"><td class="memItemLeft" align="right" valign="top">virtual U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#aaa67310324a7402bcca80535b361e287">getStreamSize</a> ()</td></tr>
  142. <tr class="memdesc:aaa67310324a7402bcca80535b361e287"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the size of the stream. <br /></td></tr>
  143. <tr class="separator:aaa67310324a7402bcca80535b361e287"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:aae324d219fc11c7110bc8563316aff1b" id="r_aae324d219fc11c7110bc8563316aff1b"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#aae324d219fc11c7110bc8563316aff1b">open</a> (const char *i_pFilename, <a class="el" href="class_file_stream.html#ab22d35ed086a478dd91e93ac78037f40">AccessMode</a> i_openMode)</td></tr>
  145. <tr class="separator:aae324d219fc11c7110bc8563316aff1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a5ae591df94fc66ccb85cbb6565368bca" id="r_a5ae591df94fc66ccb85cbb6565368bca"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#a5ae591df94fc66ccb85cbb6565368bca">close</a> ()</td></tr>
  147. <tr class="separator:a5ae591df94fc66ccb85cbb6565368bca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:a4da7f21f19bf1845c431403863efb2c1" id="r_a4da7f21f19bf1845c431403863efb2c1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#a4da7f21f19bf1845c431403863efb2c1">Flush</a> ()</td></tr>
  149. <tr class="separator:a4da7f21f19bf1845c431403863efb2c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="inherit_header pub_methods_class_stream"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_stream')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_stream.html">Stream</a></td></tr>
  151. <tr class="memitem:a7411b49ed5fda5181dd182d64984906e inherit pub_methods_class_stream" id="r_a7411b49ed5fda5181dd182d64984906e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a7411b49ed5fda5181dd182d64984906e">Stream</a> ()</td></tr>
  152. <tr class="separator:a7411b49ed5fda5181dd182d64984906e inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:a22beda3d71a767ab4601c6e3eee69491 inherit pub_methods_class_stream" id="r_a22beda3d71a767ab4601c6e3eee69491"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a22beda3d71a767ab4601c6e3eee69491">~Stream</a> ()</td></tr>
  154. <tr class="separator:a22beda3d71a767ab4601c6e3eee69491 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:a2663a82715384e64fab6987cc029e84c inherit pub_methods_class_stream" id="r_a2663a82715384e64fab6987cc029e84c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Stream::Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a2663a82715384e64fab6987cc029e84c">getStatus</a> () const</td></tr>
  156. <tr class="memdesc:a2663a82715384e64fab6987cc029e84c inherit pub_methods_class_stream"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the status of the stream. <br /></td></tr>
  157. <tr class="separator:a2663a82715384e64fab6987cc029e84c inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:a3b6a8c8788a8db1f558b682290f965b2 inherit pub_methods_class_stream" id="r_a3b6a8c8788a8db1f558b682290f965b2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a3b6a8c8788a8db1f558b682290f965b2">readLine</a> (U8 *buffer, U32 bufferSize)</td></tr>
  159. <tr class="separator:a3b6a8c8788a8db1f558b682290f965b2 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:a23412a482b81d6ff0d3ba16db2cac736 inherit pub_methods_class_stream" id="r_a23412a482b81d6ff0d3ba16db2cac736"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a23412a482b81d6ff0d3ba16db2cac736">writeLine</a> (U8 *buffer)</td></tr>
  161. <tr class="memdesc:a23412a482b81d6ff0d3ba16db2cac736 inherit pub_methods_class_stream"><td class="mdescLeft">&#160;</td><td class="mdescRight">writes a line to the stream <br /></td></tr>
  162. <tr class="separator:a23412a482b81d6ff0d3ba16db2cac736 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:a7c2c648097af54af55117de280ecf6f1 inherit pub_methods_class_stream" id="r_a7c2c648097af54af55117de280ecf6f1"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a7c2c648097af54af55117de280ecf6f1">readSTString</a> (bool casesens=false)</td></tr>
  164. <tr class="separator:a7c2c648097af54af55117de280ecf6f1 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:a2fbd4b3661401a422e85c500f5abd29b inherit pub_methods_class_stream" id="r_a2fbd4b3661401a422e85c500f5abd29b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a2fbd4b3661401a422e85c500f5abd29b">readString</a> (char stringBuf[256])</td></tr>
  166. <tr class="memdesc:a2fbd4b3661401a422e85c500f5abd29b inherit pub_methods_class_stream"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads a string of maximum 255 characters long. <br /></td></tr>
  167. <tr class="separator:a2fbd4b3661401a422e85c500f5abd29b inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:ad828e07ac7a5772761d2c4900b5d0f26 inherit pub_methods_class_stream" id="r_ad828e07ac7a5772761d2c4900b5d0f26"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#ad828e07ac7a5772761d2c4900b5d0f26">readLongString</a> (U32 maxStringLen, char *stringBuf)</td></tr>
  169. <tr class="separator:ad828e07ac7a5772761d2c4900b5d0f26 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <tr class="memitem:a68cc7469413cfaf6a91304b3ad16c989 inherit pub_methods_class_stream" id="r_a68cc7469413cfaf6a91304b3ad16c989"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a68cc7469413cfaf6a91304b3ad16c989">writeLongString</a> (U32 maxStringLen, const char *string)</td></tr>
  171. <tr class="separator:a68cc7469413cfaf6a91304b3ad16c989 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <tr class="memitem:a85fde001c721c92b173c97f75ac7a34f inherit pub_methods_class_stream" id="r_a85fde001c721c92b173c97f75ac7a34f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a85fde001c721c92b173c97f75ac7a34f">Put</a> (char character)</td></tr>
  173. <tr class="separator:a85fde001c721c92b173c97f75ac7a34f inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  174. <tr class="memitem:a156ee70ed74214c0c58538019c3e609f inherit pub_methods_class_stream" id="r_a156ee70ed74214c0c58538019c3e609f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a156ee70ed74214c0c58538019c3e609f">writeString</a> (const char *stringBuf, S32 maxLen=255)</td></tr>
  175. <tr class="memdesc:a156ee70ed74214c0c58538019c3e609f inherit pub_methods_class_stream"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes a string to the stream. <br /></td></tr>
  176. <tr class="separator:a156ee70ed74214c0c58538019c3e609f inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. <tr class="memitem:a1ca83baf06d1ce99112281e037f2cbc3 inherit pub_methods_class_stream" id="r_a1ca83baf06d1ce99112281e037f2cbc3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a1ca83baf06d1ce99112281e037f2cbc3">writeFormattedBuffer</a> (const char *format,...)</td></tr>
  178. <tr class="separator:a1ca83baf06d1ce99112281e037f2cbc3 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  179. <tr class="memitem:a824b52708cc986f47d6a5de8c50300d5 inherit pub_methods_class_stream" id="r_a824b52708cc986f47d6a5de8c50300d5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a824b52708cc986f47d6a5de8c50300d5">writeStringBuffer</a> (const char *buffer)</td></tr>
  180. <tr class="memdesc:a824b52708cc986f47d6a5de8c50300d5 inherit pub_methods_class_stream"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes a NULL terminated string buffer. <br /></td></tr>
  181. <tr class="separator:a824b52708cc986f47d6a5de8c50300d5 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  182. <tr class="memitem:ab9a1ef53f7ed4a70a01613d14e92b2dc inherit pub_methods_class_stream" id="r_ab9a1ef53f7ed4a70a01613d14e92b2dc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#ab9a1ef53f7ed4a70a01613d14e92b2dc">write</a> (const <a class="el" href="class_color_i.html">ColorI</a> &amp;)</td></tr>
  183. <tr class="memdesc:ab9a1ef53f7ed4a70a01613d14e92b2dc inherit pub_methods_class_stream"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write an integral color to the stream. <br /></td></tr>
  184. <tr class="separator:ab9a1ef53f7ed4a70a01613d14e92b2dc inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  185. <tr class="memitem:ac17b0c849807a64b7b8c09c3b3993590 inherit pub_methods_class_stream" id="r_ac17b0c849807a64b7b8c09c3b3993590"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#ac17b0c849807a64b7b8c09c3b3993590">write</a> (const <a class="el" href="class_color_f.html">ColorF</a> &amp;)</td></tr>
  186. <tr class="memdesc:ac17b0c849807a64b7b8c09c3b3993590 inherit pub_methods_class_stream"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a floating point color to the stream. <br /></td></tr>
  187. <tr class="separator:ac17b0c849807a64b7b8c09c3b3993590 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  188. <tr class="memitem:a3e6037eb5db2c7e1193fecb70cd9c59a inherit pub_methods_class_stream" id="r_a3e6037eb5db2c7e1193fecb70cd9c59a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a3e6037eb5db2c7e1193fecb70cd9c59a">read</a> (<a class="el" href="class_color_i.html">ColorI</a> *)</td></tr>
  189. <tr class="memdesc:a3e6037eb5db2c7e1193fecb70cd9c59a inherit pub_methods_class_stream"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read an integral color from the stream. <br /></td></tr>
  190. <tr class="separator:a3e6037eb5db2c7e1193fecb70cd9c59a inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  191. <tr class="memitem:af9aa8dd9deecbcd40be97d95c8782d0d inherit pub_methods_class_stream" id="r_af9aa8dd9deecbcd40be97d95c8782d0d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#af9aa8dd9deecbcd40be97d95c8782d0d">read</a> (<a class="el" href="class_color_f.html">ColorF</a> *)</td></tr>
  192. <tr class="memdesc:af9aa8dd9deecbcd40be97d95c8782d0d inherit pub_methods_class_stream"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a floating point color from the stream. <br /></td></tr>
  193. <tr class="separator:af9aa8dd9deecbcd40be97d95c8782d0d inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  194. <tr class="memitem:a1dc0218bb53ed07ba09506b7c1f62e4b inherit pub_methods_class_stream" id="r_a1dc0218bb53ed07ba09506b7c1f62e4b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a1dc0218bb53ed07ba09506b7c1f62e4b">write</a> (const <a class="el" href="struct_net_address.html">NetAddress</a> &amp;)</td></tr>
  195. <tr class="memdesc:a1dc0218bb53ed07ba09506b7c1f62e4b inherit pub_methods_class_stream"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a network address to the stream. <br /></td></tr>
  196. <tr class="separator:a1dc0218bb53ed07ba09506b7c1f62e4b inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  197. <tr class="memitem:a04b731dbfb2c7c4057abfa6d3fc0b1c1 inherit pub_methods_class_stream" id="r_a04b731dbfb2c7c4057abfa6d3fc0b1c1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a04b731dbfb2c7c4057abfa6d3fc0b1c1">read</a> (<a class="el" href="struct_net_address.html">NetAddress</a> *)</td></tr>
  198. <tr class="memdesc:a04b731dbfb2c7c4057abfa6d3fc0b1c1 inherit pub_methods_class_stream"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a network address from the stream. <br /></td></tr>
  199. <tr class="separator:a04b731dbfb2c7c4057abfa6d3fc0b1c1 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  200. <tr class="memitem:a64a7badfd176a5f129c060b7e49c3dcc inherit pub_methods_class_stream" id="r_a64a7badfd176a5f129c060b7e49c3dcc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a64a7badfd176a5f129c060b7e49c3dcc">write</a> (const <a class="el" href="class_net_socket.html">NetSocket</a> &amp;)</td></tr>
  201. <tr class="memdesc:a64a7badfd176a5f129c060b7e49c3dcc inherit pub_methods_class_stream"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a network socket to the stream. <br /></td></tr>
  202. <tr class="separator:a64a7badfd176a5f129c060b7e49c3dcc inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  203. <tr class="memitem:ae04694c3a9f0bca8216f93244cfbe893 inherit pub_methods_class_stream" id="r_ae04694c3a9f0bca8216f93244cfbe893"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#ae04694c3a9f0bca8216f93244cfbe893">read</a> (<a class="el" href="class_net_socket.html">NetSocket</a> *)</td></tr>
  204. <tr class="memdesc:ae04694c3a9f0bca8216f93244cfbe893 inherit pub_methods_class_stream"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a network socket from the stream. <br /></td></tr>
  205. <tr class="separator:ae04694c3a9f0bca8216f93244cfbe893 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  206. <tr class="memitem:a523d4b06e675df8e9c87e2366d207267 inherit pub_methods_class_stream" id="r_a523d4b06e675df8e9c87e2366d207267"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a523d4b06e675df8e9c87e2366d207267">read</a> (const U32 in_numBytes, void *out_pBuffer)</td></tr>
  207. <tr class="separator:a523d4b06e675df8e9c87e2366d207267 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  208. <tr class="memitem:afcb32d3374fda3848d85604ef33bf237 inherit pub_methods_class_stream" id="r_afcb32d3374fda3848d85604ef33bf237"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#afcb32d3374fda3848d85604ef33bf237">write</a> (const U32 in_numBytes, const void *in_pBuffer)</td></tr>
  209. <tr class="separator:afcb32d3374fda3848d85604ef33bf237 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  210. <tr class="memitem:a168060372c9991186bb2e50520614e16 inherit pub_methods_class_stream" id="r_a168060372c9991186bb2e50520614e16"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a168060372c9991186bb2e50520614e16">read</a> (bool *out_pRead)</td></tr>
  211. <tr class="separator:a168060372c9991186bb2e50520614e16 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  212. <tr class="memitem:a00ae09a31e3fa0f23b451f88f89ee755 inherit pub_methods_class_stream" id="r_a00ae09a31e3fa0f23b451f88f89ee755"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a00ae09a31e3fa0f23b451f88f89ee755">write</a> (const bool &amp;in_rWrite)</td></tr>
  213. <tr class="separator:a00ae09a31e3fa0f23b451f88f89ee755 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  214. <tr class="memitem:acdb0e38e209e1c014d0f2c10bc9127d2 inherit pub_methods_class_stream" id="r_acdb0e38e209e1c014d0f2c10bc9127d2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#acdb0e38e209e1c014d0f2c10bc9127d2">copyFrom</a> (<a class="el" href="class_stream.html">Stream</a> *other)</td></tr>
  215. <tr class="memdesc:acdb0e38e209e1c014d0f2c10bc9127d2 inherit pub_methods_class_stream"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy the contents of another stream into this one. <br /></td></tr>
  216. <tr class="separator:acdb0e38e209e1c014d0f2c10bc9127d2 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  217. <tr class="memitem:ad5c791c6efecee2afe477af5199f1e4f inherit pub_methods_class_stream" id="r_ad5c791c6efecee2afe477af5199f1e4f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#ad5c791c6efecee2afe477af5199f1e4f">writeTabs</a> (U32 count)</td></tr>
  218. <tr class="memdesc:ad5c791c6efecee2afe477af5199f1e4f inherit pub_methods_class_stream"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a number of tabs to this stream. <br /></td></tr>
  219. <tr class="separator:ad5c791c6efecee2afe477af5199f1e4f inherit pub_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  220. </table><table class="memberdecls">
  221. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
  222. Protected Member Functions</h2></td></tr>
  223. <tr class="memitem:a79a6e2ae578b0d2a70b695ee06d08941" id="r_a79a6e2ae578b0d2a70b695ee06d08941"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#a79a6e2ae578b0d2a70b695ee06d08941">FileStream</a> (const <a class="el" href="class_file_stream.html">FileStream</a> &amp;i_fileStrm)</td></tr>
  224. <tr class="separator:a79a6e2ae578b0d2a70b695ee06d08941"><td class="memSeparator" colspan="2">&#160;</td></tr>
  225. <tr class="memitem:a407b4814fb6757a9e359ab20551969d4" id="r_a407b4814fb6757a9e359ab20551969d4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file_stream.html">FileStream</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#a407b4814fb6757a9e359ab20551969d4">operator=</a> (const <a class="el" href="class_file_stream.html">FileStream</a> &amp;i_fileStrm)</td></tr>
  226. <tr class="separator:a407b4814fb6757a9e359ab20551969d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  227. <tr class="memitem:a9c22c178d21ff861c16c4562a763189d" id="r_a9c22c178d21ff861c16c4562a763189d"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#a9c22c178d21ff861c16c4562a763189d">_read</a> (const U32 i_numBytes, void *o_pBuffer)</td></tr>
  228. <tr class="separator:a9c22c178d21ff861c16c4562a763189d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  229. <tr class="memitem:a917f99ea335a66aa1278891fbaa0c69c" id="r_a917f99ea335a66aa1278891fbaa0c69c"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#a917f99ea335a66aa1278891fbaa0c69c">_write</a> (const U32 i_numBytes, const void *i_pBuffer)</td></tr>
  230. <tr class="separator:a917f99ea335a66aa1278891fbaa0c69c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  231. <tr class="memitem:a02fd73d861ef2e4aabb38c0c9ff82947" id="r_a02fd73d861ef2e4aabb38c0c9ff82947"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#a02fd73d861ef2e4aabb38c0c9ff82947">init</a> ()</td></tr>
  232. <tr class="separator:a02fd73d861ef2e4aabb38c0c9ff82947"><td class="memSeparator" colspan="2">&#160;</td></tr>
  233. <tr class="memitem:a0bee1cb2fd69b9faf87a2edb4073231c" id="r_a0bee1cb2fd69b9faf87a2edb4073231c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#a0bee1cb2fd69b9faf87a2edb4073231c">fillBuffer</a> (const U32 i_startPosition)</td></tr>
  234. <tr class="separator:a0bee1cb2fd69b9faf87a2edb4073231c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  235. <tr class="memitem:a20bbd4d45e3f01305dd709f5a9cc9952" id="r_a20bbd4d45e3f01305dd709f5a9cc9952"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#a20bbd4d45e3f01305dd709f5a9cc9952">clearBuffer</a> ()</td></tr>
  236. <tr class="separator:a20bbd4d45e3f01305dd709f5a9cc9952"><td class="memSeparator" colspan="2">&#160;</td></tr>
  237. <tr class="memitem:ab929dbde7295e6977cf35377d79b09f1" id="r_ab929dbde7295e6977cf35377d79b09f1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#ab929dbde7295e6977cf35377d79b09f1">setStatus</a> ()</td></tr>
  238. <tr class="separator:ab929dbde7295e6977cf35377d79b09f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  239. <tr class="inherit_header pro_methods_class_stream"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_stream')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="class_stream.html">Stream</a></td></tr>
  240. <tr class="memitem:a4bcd5e78dcdb4115e417b9d95de1f88e inherit pro_methods_class_stream" id="r_a4bcd5e78dcdb4115e417b9d95de1f88e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a4bcd5e78dcdb4115e417b9d95de1f88e">setStatus</a> (const <a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> in_newStatus)</td></tr>
  241. <tr class="separator:a4bcd5e78dcdb4115e417b9d95de1f88e inherit pro_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  242. </table><table class="memberdecls">
  243. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-static-methods" name="pro-static-methods"></a>
  244. Static Protected Member Functions</h2></td></tr>
  245. <tr class="memitem:ae143ee07f0c624ae27d79ba1961401da" id="r_ae143ee07f0c624ae27d79ba1961401da"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#ae143ee07f0c624ae27d79ba1961401da">calcBlockHead</a> (const U32 i_position, U32 *o_blockHead)</td></tr>
  246. <tr class="separator:ae143ee07f0c624ae27d79ba1961401da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  247. <tr class="memitem:a410c69b038c7e678e6fc08a7e3659ca1" id="r_a410c69b038c7e678e6fc08a7e3659ca1"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#a410c69b038c7e678e6fc08a7e3659ca1">calcBlockBounds</a> (const U32 i_position, U32 *o_blockHead, U32 *o_blockTail)</td></tr>
  248. <tr class="separator:a410c69b038c7e678e6fc08a7e3659ca1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  249. </table><table class="memberdecls">
  250. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
  251. Protected Attributes</h2></td></tr>
  252. <tr class="memitem:a326236728883a3659afba508af00bd5c" id="r_a326236728883a3659afba508af00bd5c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file.html">File</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#a326236728883a3659afba508af00bd5c">mFile</a></td></tr>
  253. <tr class="separator:a326236728883a3659afba508af00bd5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  254. <tr class="memitem:a0358dba6e91f7f0c8cc78be5b31c4686" id="r_a0358dba6e91f7f0c8cc78be5b31c4686"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#a0358dba6e91f7f0c8cc78be5b31c4686">mStreamCaps</a></td></tr>
  255. <tr class="separator:a0358dba6e91f7f0c8cc78be5b31c4686"><td class="memSeparator" colspan="2">&#160;</td></tr>
  256. <tr class="memitem:af0b836f42e76b45209253de4193e0bb5" id="r_af0b836f42e76b45209253de4193e0bb5"><td class="memItemLeft" align="right" valign="top">U8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#af0b836f42e76b45209253de4193e0bb5">mBuffer</a> [<a class="el" href="class_file_stream.html#a16af7b253440dadd46a80a4b9fddba4da1a63387ea87dae07937bf38548748733">BUFFER_SIZE</a>]</td></tr>
  257. <tr class="separator:af0b836f42e76b45209253de4193e0bb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  258. <tr class="memitem:a8bc4fdb5cd0e6af74b52286c983041b7" id="r_a8bc4fdb5cd0e6af74b52286c983041b7"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#a8bc4fdb5cd0e6af74b52286c983041b7">mBuffHead</a></td></tr>
  259. <tr class="separator:a8bc4fdb5cd0e6af74b52286c983041b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  260. <tr class="memitem:ac09835f4b14fe5b7407d602991907321" id="r_ac09835f4b14fe5b7407d602991907321"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#ac09835f4b14fe5b7407d602991907321">mBuffPos</a></td></tr>
  261. <tr class="separator:ac09835f4b14fe5b7407d602991907321"><td class="memSeparator" colspan="2">&#160;</td></tr>
  262. <tr class="memitem:af9c53701541ae847e8817e1af97e17a4" id="r_af9c53701541ae847e8817e1af97e17a4"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#af9c53701541ae847e8817e1af97e17a4">mBuffTail</a></td></tr>
  263. <tr class="separator:af9c53701541ae847e8817e1af97e17a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  264. <tr class="memitem:ae359f43cc65ae5e26cfd52dc66ea5083" id="r_ae359f43cc65ae5e26cfd52dc66ea5083"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#ae359f43cc65ae5e26cfd52dc66ea5083">mDirty</a></td></tr>
  265. <tr class="separator:ae359f43cc65ae5e26cfd52dc66ea5083"><td class="memSeparator" colspan="2">&#160;</td></tr>
  266. <tr class="memitem:adcabb724c7db89efcf38af191bcc784c" id="r_adcabb724c7db89efcf38af191bcc784c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_stream.html#adcabb724c7db89efcf38af191bcc784c">mEOF</a></td></tr>
  267. <tr class="separator:adcabb724c7db89efcf38af191bcc784c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  268. </table><table class="memberdecls">
  269. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
  270. Additional Inherited Members</h2></td></tr>
  271. <tr class="inherit_header pub_static_methods_class_stream"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_class_stream')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="class_stream.html">Stream</a></td></tr>
  272. <tr class="memitem:a4bf9a6c6f388ed0d137d5ded0fd86ead inherit pub_static_methods_class_stream" id="r_a4bf9a6c6f388ed0d137d5ded0fd86ead"><td class="memItemLeft" align="right" valign="top">static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a4bf9a6c6f388ed0d137d5ded0fd86ead">getStatusString</a> (const <a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> in_status)</td></tr>
  273. <tr class="memdesc:a4bf9a6c6f388ed0d137d5ded0fd86ead inherit pub_static_methods_class_stream"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a printable string form of the status. <br /></td></tr>
  274. <tr class="separator:a4bf9a6c6f388ed0d137d5ded0fd86ead inherit pub_static_methods_class_stream"><td class="memSeparator" colspan="2">&#160;</td></tr>
  275. </table>
  276. <h2 class="groupheader">Member Enumeration Documentation</h2>
  277. <a id="a16af7b253440dadd46a80a4b9fddba4d" name="a16af7b253440dadd46a80a4b9fddba4d"></a>
  278. <h2 class="memtitle"><span class="permalink"><a href="#a16af7b253440dadd46a80a4b9fddba4d">&#9670;&#160;</a></span>anonymous enum</h2>
  279. <div class="memitem">
  280. <div class="memproto">
  281. <table class="memname">
  282. <tr>
  283. <td class="memname">anonymous enum</td>
  284. </tr>
  285. </table>
  286. </div><div class="memdoc">
  287. <table class="fieldtable">
  288. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a16af7b253440dadd46a80a4b9fddba4da1a63387ea87dae07937bf38548748733" name="a16af7b253440dadd46a80a4b9fddba4da1a63387ea87dae07937bf38548748733"></a>BUFFER_SIZE&#160;</td><td class="fielddoc"></td></tr>
  289. <tr><td class="fieldname"><a id="a16af7b253440dadd46a80a4b9fddba4da4c9e74658923bde10a0f25eaf32a5be2" name="a16af7b253440dadd46a80a4b9fddba4da4c9e74658923bde10a0f25eaf32a5be2"></a>BUFFER_INVALID&#160;</td><td class="fielddoc"></td></tr>
  290. </table>
  291. </div>
  292. </div>
  293. <a id="ab22d35ed086a478dd91e93ac78037f40" name="ab22d35ed086a478dd91e93ac78037f40"></a>
  294. <h2 class="memtitle"><span class="permalink"><a href="#ab22d35ed086a478dd91e93ac78037f40">&#9670;&#160;</a></span>AccessMode</h2>
  295. <div class="memitem">
  296. <div class="memproto">
  297. <table class="memname">
  298. <tr>
  299. <td class="memname">enum <a class="el" href="class_file_stream.html#ab22d35ed086a478dd91e93ac78037f40">AccessMode</a></td>
  300. </tr>
  301. </table>
  302. </div><div class="memdoc">
  303. <table class="fieldtable">
  304. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ab22d35ed086a478dd91e93ac78037f40a809abe96853e69894bbf8e5730b31348" name="ab22d35ed086a478dd91e93ac78037f40a809abe96853e69894bbf8e5730b31348"></a>Read&#160;</td><td class="fielddoc"></td></tr>
  305. <tr><td class="fieldname"><a id="ab22d35ed086a478dd91e93ac78037f40aa56670174817e3fed92bfd8182d7c0d1" name="ab22d35ed086a478dd91e93ac78037f40aa56670174817e3fed92bfd8182d7c0d1"></a>Write&#160;</td><td class="fielddoc"></td></tr>
  306. <tr><td class="fieldname"><a id="ab22d35ed086a478dd91e93ac78037f40a3c4d2d19c91b345c33a83ca9f551f4e1" name="ab22d35ed086a478dd91e93ac78037f40a3c4d2d19c91b345c33a83ca9f551f4e1"></a>ReadWrite&#160;</td><td class="fielddoc"></td></tr>
  307. <tr><td class="fieldname"><a id="ab22d35ed086a478dd91e93ac78037f40a41d36294f7608c7e5565aee5aee6dcf7" name="ab22d35ed086a478dd91e93ac78037f40a41d36294f7608c7e5565aee5aee6dcf7"></a>WriteAppend&#160;</td><td class="fielddoc"></td></tr>
  308. </table>
  309. </div>
  310. </div>
  311. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  312. <a id="a79a6e2ae578b0d2a70b695ee06d08941" name="a79a6e2ae578b0d2a70b695ee06d08941"></a>
  313. <h2 class="memtitle"><span class="permalink"><a href="#a79a6e2ae578b0d2a70b695ee06d08941">&#9670;&#160;</a></span>FileStream() <span class="overload">[1/2]</span></h2>
  314. <div class="memitem">
  315. <div class="memproto">
  316. <table class="mlabels">
  317. <tr>
  318. <td class="mlabels-left">
  319. <table class="memname">
  320. <tr>
  321. <td class="memname"><a class="el" href="class_file_stream.html">FileStream</a> </td>
  322. <td>(</td>
  323. <td class="paramtype">const <a class="el" href="class_file_stream.html">FileStream</a> &amp;&#160;</td>
  324. <td class="paramname"><em>i_fileStrm</em></td><td>)</td>
  325. <td></td>
  326. </tr>
  327. </table>
  328. </td>
  329. <td class="mlabels-right">
  330. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  331. </tr>
  332. </table>
  333. </div><div class="memdoc">
  334. </div>
  335. </div>
  336. <a id="aa4f8549edc02f08b2287f3f472fa4ed6" name="aa4f8549edc02f08b2287f3f472fa4ed6"></a>
  337. <h2 class="memtitle"><span class="permalink"><a href="#aa4f8549edc02f08b2287f3f472fa4ed6">&#9670;&#160;</a></span>FileStream() <span class="overload">[2/2]</span></h2>
  338. <div class="memitem">
  339. <div class="memproto">
  340. <table class="memname">
  341. <tr>
  342. <td class="memname"><a class="el" href="class_file_stream.html">FileStream</a> </td>
  343. <td>(</td>
  344. <td class="paramname"></td><td>)</td>
  345. <td></td>
  346. </tr>
  347. </table>
  348. </div><div class="memdoc">
  349. </div>
  350. </div>
  351. <a id="a19e0b2bee0e3bc81ea6e6ba6c6a44134" name="a19e0b2bee0e3bc81ea6e6ba6c6a44134"></a>
  352. <h2 class="memtitle"><span class="permalink"><a href="#a19e0b2bee0e3bc81ea6e6ba6c6a44134">&#9670;&#160;</a></span>~FileStream()</h2>
  353. <div class="memitem">
  354. <div class="memproto">
  355. <table class="mlabels">
  356. <tr>
  357. <td class="mlabels-left">
  358. <table class="memname">
  359. <tr>
  360. <td class="memname">~<a class="el" href="class_file_stream.html">FileStream</a> </td>
  361. <td>(</td>
  362. <td class="paramname"></td><td>)</td>
  363. <td></td>
  364. </tr>
  365. </table>
  366. </td>
  367. <td class="mlabels-right">
  368. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  369. </tr>
  370. </table>
  371. </div><div class="memdoc">
  372. </div>
  373. </div>
  374. <h2 class="groupheader">Member Function Documentation</h2>
  375. <a id="a9c22c178d21ff861c16c4562a763189d" name="a9c22c178d21ff861c16c4562a763189d"></a>
  376. <h2 class="memtitle"><span class="permalink"><a href="#a9c22c178d21ff861c16c4562a763189d">&#9670;&#160;</a></span>_read()</h2>
  377. <div class="memitem">
  378. <div class="memproto">
  379. <table class="mlabels">
  380. <tr>
  381. <td class="mlabels-left">
  382. <table class="memname">
  383. <tr>
  384. <td class="memname">bool _read </td>
  385. <td>(</td>
  386. <td class="paramtype">const U32&#160;</td>
  387. <td class="paramname"><em>i_numBytes</em>, </td>
  388. </tr>
  389. <tr>
  390. <td class="paramkey"></td>
  391. <td></td>
  392. <td class="paramtype">void *&#160;</td>
  393. <td class="paramname"><em>o_pBuffer</em>&#160;</td>
  394. </tr>
  395. <tr>
  396. <td></td>
  397. <td>)</td>
  398. <td></td><td></td>
  399. </tr>
  400. </table>
  401. </td>
  402. <td class="mlabels-right">
  403. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  404. </tr>
  405. </table>
  406. </div><div class="memdoc">
  407. <p>Implements <a class="el" href="class_stream.html#a773fde4a45c9aaeac3cec389fae8a1e0">Stream</a>.</p>
  408. </div>
  409. </div>
  410. <a id="a917f99ea335a66aa1278891fbaa0c69c" name="a917f99ea335a66aa1278891fbaa0c69c"></a>
  411. <h2 class="memtitle"><span class="permalink"><a href="#a917f99ea335a66aa1278891fbaa0c69c">&#9670;&#160;</a></span>_write()</h2>
  412. <div class="memitem">
  413. <div class="memproto">
  414. <table class="mlabels">
  415. <tr>
  416. <td class="mlabels-left">
  417. <table class="memname">
  418. <tr>
  419. <td class="memname">bool _write </td>
  420. <td>(</td>
  421. <td class="paramtype">const U32&#160;</td>
  422. <td class="paramname"><em>i_numBytes</em>, </td>
  423. </tr>
  424. <tr>
  425. <td class="paramkey"></td>
  426. <td></td>
  427. <td class="paramtype">const void *&#160;</td>
  428. <td class="paramname"><em>i_pBuffer</em>&#160;</td>
  429. </tr>
  430. <tr>
  431. <td></td>
  432. <td>)</td>
  433. <td></td><td></td>
  434. </tr>
  435. </table>
  436. </td>
  437. <td class="mlabels-right">
  438. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  439. </tr>
  440. </table>
  441. </div><div class="memdoc">
  442. <p>Implements <a class="el" href="class_stream.html#ab2e5ce9f07d6f9ac70d319d8db8ca82e">Stream</a>.</p>
  443. </div>
  444. </div>
  445. <a id="a410c69b038c7e678e6fc08a7e3659ca1" name="a410c69b038c7e678e6fc08a7e3659ca1"></a>
  446. <h2 class="memtitle"><span class="permalink"><a href="#a410c69b038c7e678e6fc08a7e3659ca1">&#9670;&#160;</a></span>calcBlockBounds()</h2>
  447. <div class="memitem">
  448. <div class="memproto">
  449. <table class="mlabels">
  450. <tr>
  451. <td class="mlabels-left">
  452. <table class="memname">
  453. <tr>
  454. <td class="memname">void calcBlockBounds </td>
  455. <td>(</td>
  456. <td class="paramtype">const U32&#160;</td>
  457. <td class="paramname"><em>i_position</em>, </td>
  458. </tr>
  459. <tr>
  460. <td class="paramkey"></td>
  461. <td></td>
  462. <td class="paramtype">U32 *&#160;</td>
  463. <td class="paramname"><em>o_blockHead</em>, </td>
  464. </tr>
  465. <tr>
  466. <td class="paramkey"></td>
  467. <td></td>
  468. <td class="paramtype">U32 *&#160;</td>
  469. <td class="paramname"><em>o_blockTail</em>&#160;</td>
  470. </tr>
  471. <tr>
  472. <td></td>
  473. <td>)</td>
  474. <td></td><td></td>
  475. </tr>
  476. </table>
  477. </td>
  478. <td class="mlabels-right">
  479. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
  480. </tr>
  481. </table>
  482. </div><div class="memdoc">
  483. </div>
  484. </div>
  485. <a id="ae143ee07f0c624ae27d79ba1961401da" name="ae143ee07f0c624ae27d79ba1961401da"></a>
  486. <h2 class="memtitle"><span class="permalink"><a href="#ae143ee07f0c624ae27d79ba1961401da">&#9670;&#160;</a></span>calcBlockHead()</h2>
  487. <div class="memitem">
  488. <div class="memproto">
  489. <table class="mlabels">
  490. <tr>
  491. <td class="mlabels-left">
  492. <table class="memname">
  493. <tr>
  494. <td class="memname">void calcBlockHead </td>
  495. <td>(</td>
  496. <td class="paramtype">const U32&#160;</td>
  497. <td class="paramname"><em>i_position</em>, </td>
  498. </tr>
  499. <tr>
  500. <td class="paramkey"></td>
  501. <td></td>
  502. <td class="paramtype">U32 *&#160;</td>
  503. <td class="paramname"><em>o_blockHead</em>&#160;</td>
  504. </tr>
  505. <tr>
  506. <td></td>
  507. <td>)</td>
  508. <td></td><td></td>
  509. </tr>
  510. </table>
  511. </td>
  512. <td class="mlabels-right">
  513. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
  514. </tr>
  515. </table>
  516. </div><div class="memdoc">
  517. </div>
  518. </div>
  519. <a id="a20bbd4d45e3f01305dd709f5a9cc9952" name="a20bbd4d45e3f01305dd709f5a9cc9952"></a>
  520. <h2 class="memtitle"><span class="permalink"><a href="#a20bbd4d45e3f01305dd709f5a9cc9952">&#9670;&#160;</a></span>clearBuffer()</h2>
  521. <div class="memitem">
  522. <div class="memproto">
  523. <table class="mlabels">
  524. <tr>
  525. <td class="mlabels-left">
  526. <table class="memname">
  527. <tr>
  528. <td class="memname">void clearBuffer </td>
  529. <td>(</td>
  530. <td class="paramname"></td><td>)</td>
  531. <td></td>
  532. </tr>
  533. </table>
  534. </td>
  535. <td class="mlabels-right">
  536. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  537. </tr>
  538. </table>
  539. </div><div class="memdoc">
  540. </div>
  541. </div>
  542. <a id="a5ae591df94fc66ccb85cbb6565368bca" name="a5ae591df94fc66ccb85cbb6565368bca"></a>
  543. <h2 class="memtitle"><span class="permalink"><a href="#a5ae591df94fc66ccb85cbb6565368bca">&#9670;&#160;</a></span>close()</h2>
  544. <div class="memitem">
  545. <div class="memproto">
  546. <table class="mlabels">
  547. <tr>
  548. <td class="mlabels-left">
  549. <table class="memname">
  550. <tr>
  551. <td class="memname">void close </td>
  552. <td>(</td>
  553. <td class="paramname"></td><td>)</td>
  554. <td></td>
  555. </tr>
  556. </table>
  557. </td>
  558. <td class="mlabels-right">
  559. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  560. </tr>
  561. </table>
  562. </div><div class="memdoc">
  563. <p>Reimplemented in <a class="el" href="class_zip_1_1_zip_temp_stream.html#a47feccb1873356363e4d0e302bc3822c">ZipTempStream</a>.</p>
  564. </div>
  565. </div>
  566. <a id="a0bee1cb2fd69b9faf87a2edb4073231c" name="a0bee1cb2fd69b9faf87a2edb4073231c"></a>
  567. <h2 class="memtitle"><span class="permalink"><a href="#a0bee1cb2fd69b9faf87a2edb4073231c">&#9670;&#160;</a></span>fillBuffer()</h2>
  568. <div class="memitem">
  569. <div class="memproto">
  570. <table class="mlabels">
  571. <tr>
  572. <td class="mlabels-left">
  573. <table class="memname">
  574. <tr>
  575. <td class="memname">bool fillBuffer </td>
  576. <td>(</td>
  577. <td class="paramtype">const U32&#160;</td>
  578. <td class="paramname"><em>i_startPosition</em></td><td>)</td>
  579. <td></td>
  580. </tr>
  581. </table>
  582. </td>
  583. <td class="mlabels-right">
  584. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  585. </tr>
  586. </table>
  587. </div><div class="memdoc">
  588. </div>
  589. </div>
  590. <a id="a4da7f21f19bf1845c431403863efb2c1" name="a4da7f21f19bf1845c431403863efb2c1"></a>
  591. <h2 class="memtitle"><span class="permalink"><a href="#a4da7f21f19bf1845c431403863efb2c1">&#9670;&#160;</a></span>Flush()</h2>
  592. <div class="memitem">
  593. <div class="memproto">
  594. <table class="memname">
  595. <tr>
  596. <td class="memname">bool Flush </td>
  597. <td>(</td>
  598. <td class="paramname"></td><td>)</td>
  599. <td></td>
  600. </tr>
  601. </table>
  602. </div><div class="memdoc">
  603. </div>
  604. </div>
  605. <a id="ae91252bdbffcafaefaa6edec813a3c1e" name="ae91252bdbffcafaefaa6edec813a3c1e"></a>
  606. <h2 class="memtitle"><span class="permalink"><a href="#ae91252bdbffcafaefaa6edec813a3c1e">&#9670;&#160;</a></span>getPosition()</h2>
  607. <div class="memitem">
  608. <div class="memproto">
  609. <table class="mlabels">
  610. <tr>
  611. <td class="mlabels-left">
  612. <table class="memname">
  613. <tr>
  614. <td class="memname">U32 getPosition </td>
  615. <td>(</td>
  616. <td class="paramname"></td><td>)</td>
  617. <td> const</td>
  618. </tr>
  619. </table>
  620. </td>
  621. <td class="mlabels-right">
  622. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  623. </tr>
  624. </table>
  625. </div><div class="memdoc">
  626. <p>Gets the position in the stream. </p>
  627. <p>Implements <a class="el" href="class_stream.html#adcbf5c2ff0391d5e17c642e2f1452853">Stream</a>.</p>
  628. </div>
  629. </div>
  630. <a id="aaa67310324a7402bcca80535b361e287" name="aaa67310324a7402bcca80535b361e287"></a>
  631. <h2 class="memtitle"><span class="permalink"><a href="#aaa67310324a7402bcca80535b361e287">&#9670;&#160;</a></span>getStreamSize()</h2>
  632. <div class="memitem">
  633. <div class="memproto">
  634. <table class="mlabels">
  635. <tr>
  636. <td class="mlabels-left">
  637. <table class="memname">
  638. <tr>
  639. <td class="memname">U32 getStreamSize </td>
  640. <td>(</td>
  641. <td class="paramname"></td><td>)</td>
  642. <td></td>
  643. </tr>
  644. </table>
  645. </td>
  646. <td class="mlabels-right">
  647. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  648. </tr>
  649. </table>
  650. </div><div class="memdoc">
  651. <p>Gets the size of the stream. </p>
  652. <p>Implements <a class="el" href="class_stream.html#a7f75bbe456f33c8e75a34d5d5993e4ac">Stream</a>.</p>
  653. </div>
  654. </div>
  655. <a id="ac9b5a7153e82dc56e88e5d427de6d8b7" name="ac9b5a7153e82dc56e88e5d427de6d8b7"></a>
  656. <h2 class="memtitle"><span class="permalink"><a href="#ac9b5a7153e82dc56e88e5d427de6d8b7">&#9670;&#160;</a></span>hasCapability()</h2>
  657. <div class="memitem">
  658. <div class="memproto">
  659. <table class="mlabels">
  660. <tr>
  661. <td class="mlabels-left">
  662. <table class="memname">
  663. <tr>
  664. <td class="memname">bool hasCapability </td>
  665. <td>(</td>
  666. <td class="paramtype">const <a class="el" href="class_stream.html#a4171335401279aad7e5a463349c093c6">Capability</a>&#160;</td>
  667. <td class="paramname"></td><td>)</td>
  668. <td> const</td>
  669. </tr>
  670. </table>
  671. </td>
  672. <td class="mlabels-right">
  673. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  674. </tr>
  675. </table>
  676. </div><div class="memdoc">
  677. <p>Checks to see if this stream has the capability of a given function. </p>
  678. <p>Implements <a class="el" href="class_stream.html#a2364a8fe7d4185385b5336af85e6e8aa">Stream</a>.</p>
  679. </div>
  680. </div>
  681. <a id="a02fd73d861ef2e4aabb38c0c9ff82947" name="a02fd73d861ef2e4aabb38c0c9ff82947"></a>
  682. <h2 class="memtitle"><span class="permalink"><a href="#a02fd73d861ef2e4aabb38c0c9ff82947">&#9670;&#160;</a></span>init()</h2>
  683. <div class="memitem">
  684. <div class="memproto">
  685. <table class="mlabels">
  686. <tr>
  687. <td class="mlabels-left">
  688. <table class="memname">
  689. <tr>
  690. <td class="memname">void init </td>
  691. <td>(</td>
  692. <td class="paramname"></td><td>)</td>
  693. <td></td>
  694. </tr>
  695. </table>
  696. </td>
  697. <td class="mlabels-right">
  698. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  699. </tr>
  700. </table>
  701. </div><div class="memdoc">
  702. </div>
  703. </div>
  704. <a id="aae324d219fc11c7110bc8563316aff1b" name="aae324d219fc11c7110bc8563316aff1b"></a>
  705. <h2 class="memtitle"><span class="permalink"><a href="#aae324d219fc11c7110bc8563316aff1b">&#9670;&#160;</a></span>open()</h2>
  706. <div class="memitem">
  707. <div class="memproto">
  708. <table class="mlabels">
  709. <tr>
  710. <td class="mlabels-left">
  711. <table class="memname">
  712. <tr>
  713. <td class="memname">bool open </td>
  714. <td>(</td>
  715. <td class="paramtype">const char *&#160;</td>
  716. <td class="paramname"><em>i_pFilename</em>, </td>
  717. </tr>
  718. <tr>
  719. <td class="paramkey"></td>
  720. <td></td>
  721. <td class="paramtype"><a class="el" href="class_file_stream.html#ab22d35ed086a478dd91e93ac78037f40">AccessMode</a>&#160;</td>
  722. <td class="paramname"><em>i_openMode</em>&#160;</td>
  723. </tr>
  724. <tr>
  725. <td></td>
  726. <td>)</td>
  727. <td></td><td></td>
  728. </tr>
  729. </table>
  730. </td>
  731. <td class="mlabels-right">
  732. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  733. </tr>
  734. </table>
  735. </div><div class="memdoc">
  736. <p>Reimplemented in <a class="el" href="class_zip_1_1_zip_temp_stream.html#adaba9e33e205622b2226dd09fe17e0b8">ZipTempStream</a>.</p>
  737. </div>
  738. </div>
  739. <a id="a407b4814fb6757a9e359ab20551969d4" name="a407b4814fb6757a9e359ab20551969d4"></a>
  740. <h2 class="memtitle"><span class="permalink"><a href="#a407b4814fb6757a9e359ab20551969d4">&#9670;&#160;</a></span>operator=()</h2>
  741. <div class="memitem">
  742. <div class="memproto">
  743. <table class="mlabels">
  744. <tr>
  745. <td class="mlabels-left">
  746. <table class="memname">
  747. <tr>
  748. <td class="memname"><a class="el" href="class_file_stream.html">FileStream</a> &amp; operator= </td>
  749. <td>(</td>
  750. <td class="paramtype">const <a class="el" href="class_file_stream.html">FileStream</a> &amp;&#160;</td>
  751. <td class="paramname"><em>i_fileStrm</em></td><td>)</td>
  752. <td></td>
  753. </tr>
  754. </table>
  755. </td>
  756. <td class="mlabels-right">
  757. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  758. </tr>
  759. </table>
  760. </div><div class="memdoc">
  761. </div>
  762. </div>
  763. <a id="a75d0bd9d352b99b88457e772a43df38d" name="a75d0bd9d352b99b88457e772a43df38d"></a>
  764. <h2 class="memtitle"><span class="permalink"><a href="#a75d0bd9d352b99b88457e772a43df38d">&#9670;&#160;</a></span>setPosition()</h2>
  765. <div class="memitem">
  766. <div class="memproto">
  767. <table class="mlabels">
  768. <tr>
  769. <td class="mlabels-left">
  770. <table class="memname">
  771. <tr>
  772. <td class="memname">bool setPosition </td>
  773. <td>(</td>
  774. <td class="paramtype">const U32&#160;</td>
  775. <td class="paramname"><em>in_newPosition</em></td><td>)</td>
  776. <td></td>
  777. </tr>
  778. </table>
  779. </td>
  780. <td class="mlabels-right">
  781. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  782. </tr>
  783. </table>
  784. </div><div class="memdoc">
  785. <p>Sets the position of the stream. Returns if the new position is valid or not. </p>
  786. <p>Implements <a class="el" href="class_stream.html#a813fa6fbeaefd6be02b090ac7f116abc">Stream</a>.</p>
  787. <p>Reimplemented in <a class="el" href="class_zip_1_1_zip_temp_stream.html#ab2f5f68611f8eb0ac9c723ae68855590">ZipTempStream</a>.</p>
  788. </div>
  789. </div>
  790. <a id="ab929dbde7295e6977cf35377d79b09f1" name="ab929dbde7295e6977cf35377d79b09f1"></a>
  791. <h2 class="memtitle"><span class="permalink"><a href="#ab929dbde7295e6977cf35377d79b09f1">&#9670;&#160;</a></span>setStatus()</h2>
  792. <div class="memitem">
  793. <div class="memproto">
  794. <table class="mlabels">
  795. <tr>
  796. <td class="mlabels-left">
  797. <table class="memname">
  798. <tr>
  799. <td class="memname">void setStatus </td>
  800. <td>(</td>
  801. <td class="paramname"></td><td>)</td>
  802. <td></td>
  803. </tr>
  804. </table>
  805. </td>
  806. <td class="mlabels-right">
  807. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  808. </tr>
  809. </table>
  810. </div><div class="memdoc">
  811. </div>
  812. </div>
  813. <h2 class="groupheader">Member Data Documentation</h2>
  814. <a id="af0b836f42e76b45209253de4193e0bb5" name="af0b836f42e76b45209253de4193e0bb5"></a>
  815. <h2 class="memtitle"><span class="permalink"><a href="#af0b836f42e76b45209253de4193e0bb5">&#9670;&#160;</a></span>mBuffer</h2>
  816. <div class="memitem">
  817. <div class="memproto">
  818. <table class="mlabels">
  819. <tr>
  820. <td class="mlabels-left">
  821. <table class="memname">
  822. <tr>
  823. <td class="memname">U8 mBuffer[<a class="el" href="class_file_stream.html#a16af7b253440dadd46a80a4b9fddba4da1a63387ea87dae07937bf38548748733">BUFFER_SIZE</a>]</td>
  824. </tr>
  825. </table>
  826. </td>
  827. <td class="mlabels-right">
  828. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  829. </tr>
  830. </table>
  831. </div><div class="memdoc">
  832. </div>
  833. </div>
  834. <a id="a8bc4fdb5cd0e6af74b52286c983041b7" name="a8bc4fdb5cd0e6af74b52286c983041b7"></a>
  835. <h2 class="memtitle"><span class="permalink"><a href="#a8bc4fdb5cd0e6af74b52286c983041b7">&#9670;&#160;</a></span>mBuffHead</h2>
  836. <div class="memitem">
  837. <div class="memproto">
  838. <table class="mlabels">
  839. <tr>
  840. <td class="mlabels-left">
  841. <table class="memname">
  842. <tr>
  843. <td class="memname">U32 mBuffHead</td>
  844. </tr>
  845. </table>
  846. </td>
  847. <td class="mlabels-right">
  848. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  849. </tr>
  850. </table>
  851. </div><div class="memdoc">
  852. </div>
  853. </div>
  854. <a id="ac09835f4b14fe5b7407d602991907321" name="ac09835f4b14fe5b7407d602991907321"></a>
  855. <h2 class="memtitle"><span class="permalink"><a href="#ac09835f4b14fe5b7407d602991907321">&#9670;&#160;</a></span>mBuffPos</h2>
  856. <div class="memitem">
  857. <div class="memproto">
  858. <table class="mlabels">
  859. <tr>
  860. <td class="mlabels-left">
  861. <table class="memname">
  862. <tr>
  863. <td class="memname">U32 mBuffPos</td>
  864. </tr>
  865. </table>
  866. </td>
  867. <td class="mlabels-right">
  868. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  869. </tr>
  870. </table>
  871. </div><div class="memdoc">
  872. </div>
  873. </div>
  874. <a id="af9c53701541ae847e8817e1af97e17a4" name="af9c53701541ae847e8817e1af97e17a4"></a>
  875. <h2 class="memtitle"><span class="permalink"><a href="#af9c53701541ae847e8817e1af97e17a4">&#9670;&#160;</a></span>mBuffTail</h2>
  876. <div class="memitem">
  877. <div class="memproto">
  878. <table class="mlabels">
  879. <tr>
  880. <td class="mlabels-left">
  881. <table class="memname">
  882. <tr>
  883. <td class="memname">U32 mBuffTail</td>
  884. </tr>
  885. </table>
  886. </td>
  887. <td class="mlabels-right">
  888. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  889. </tr>
  890. </table>
  891. </div><div class="memdoc">
  892. </div>
  893. </div>
  894. <a id="ae359f43cc65ae5e26cfd52dc66ea5083" name="ae359f43cc65ae5e26cfd52dc66ea5083"></a>
  895. <h2 class="memtitle"><span class="permalink"><a href="#ae359f43cc65ae5e26cfd52dc66ea5083">&#9670;&#160;</a></span>mDirty</h2>
  896. <div class="memitem">
  897. <div class="memproto">
  898. <table class="mlabels">
  899. <tr>
  900. <td class="mlabels-left">
  901. <table class="memname">
  902. <tr>
  903. <td class="memname">bool mDirty</td>
  904. </tr>
  905. </table>
  906. </td>
  907. <td class="mlabels-right">
  908. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  909. </tr>
  910. </table>
  911. </div><div class="memdoc">
  912. </div>
  913. </div>
  914. <a id="adcabb724c7db89efcf38af191bcc784c" name="adcabb724c7db89efcf38af191bcc784c"></a>
  915. <h2 class="memtitle"><span class="permalink"><a href="#adcabb724c7db89efcf38af191bcc784c">&#9670;&#160;</a></span>mEOF</h2>
  916. <div class="memitem">
  917. <div class="memproto">
  918. <table class="mlabels">
  919. <tr>
  920. <td class="mlabels-left">
  921. <table class="memname">
  922. <tr>
  923. <td class="memname">bool mEOF</td>
  924. </tr>
  925. </table>
  926. </td>
  927. <td class="mlabels-right">
  928. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  929. </tr>
  930. </table>
  931. </div><div class="memdoc">
  932. </div>
  933. </div>
  934. <a id="a326236728883a3659afba508af00bd5c" name="a326236728883a3659afba508af00bd5c"></a>
  935. <h2 class="memtitle"><span class="permalink"><a href="#a326236728883a3659afba508af00bd5c">&#9670;&#160;</a></span>mFile</h2>
  936. <div class="memitem">
  937. <div class="memproto">
  938. <table class="mlabels">
  939. <tr>
  940. <td class="mlabels-left">
  941. <table class="memname">
  942. <tr>
  943. <td class="memname"><a class="el" href="class_file.html">File</a> mFile</td>
  944. </tr>
  945. </table>
  946. </td>
  947. <td class="mlabels-right">
  948. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  949. </tr>
  950. </table>
  951. </div><div class="memdoc">
  952. </div>
  953. </div>
  954. <a id="a0358dba6e91f7f0c8cc78be5b31c4686" name="a0358dba6e91f7f0c8cc78be5b31c4686"></a>
  955. <h2 class="memtitle"><span class="permalink"><a href="#a0358dba6e91f7f0c8cc78be5b31c4686">&#9670;&#160;</a></span>mStreamCaps</h2>
  956. <div class="memitem">
  957. <div class="memproto">
  958. <table class="mlabels">
  959. <tr>
  960. <td class="mlabels-left">
  961. <table class="memname">
  962. <tr>
  963. <td class="memname">U32 mStreamCaps</td>
  964. </tr>
  965. </table>
  966. </td>
  967. <td class="mlabels-right">
  968. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  969. </tr>
  970. </table>
  971. </div><div class="memdoc">
  972. </div>
  973. </div>
  974. <hr/>The documentation for this class was generated from the following files:<ul>
  975. <li>io/<b>fileStream.h</b></li>
  976. <li>io/<b>fileStream.cc</b></li>
  977. </ul>
  978. </div><!-- contents -->
  979. <!-- start footer part -->
  980. <hr class="footer"/><address class="footer"><small>
  981. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
  982. </small></address>
  983. </body>
  984. </html>