You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

258 lines
18 KiB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.9.1"/>
  7. <title>Xerces-C++: BinInputStream Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td style="padding-left: 0.5em;">
  20. <div id="projectname">Xerces-C++
  21. &#160;<span id="projectnumber">3.1.2</span>
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.9.1 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  35. <li><a href="files.html"><span>Files</span></a></li>
  36. </ul>
  37. </div>
  38. <div id="navrow2" class="tabs2">
  39. <ul class="tablist">
  40. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  41. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  42. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  43. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  44. </ul>
  45. </div>
  46. </div><!-- top -->
  47. <div class="header">
  48. <div class="summary">
  49. <a href="#pub-methods">Public Member Functions</a> &#124;
  50. <a href="#pro-methods">Protected Member Functions</a> &#124;
  51. <a href="classBinInputStream-members.html">List of all members</a> </div>
  52. <div class="headertitle">
  53. <div class="title">BinInputStream Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  54. </div><!--header-->
  55. <div class="contents">
  56. <div class="dynheader">
  57. Inheritance diagram for BinInputStream:</div>
  58. <div class="dyncontent">
  59. <div class="center">
  60. <img src="classBinInputStream.png" usemap="#BinInputStream_map" alt=""/>
  61. <map id="BinInputStream_map" name="BinInputStream_map">
  62. <area href="classXMemory.html" title="This class makes it possible to override the C++ memory management by adding new/delete operators to ..." alt="XMemory" shape="rect" coords="66,0,189,24"/>
  63. <area href="classBinFileInputStream.html" alt="BinFileInputStream" shape="rect" coords="0,112,123,136"/>
  64. <area href="classBinMemInputStream.html" alt="BinMemInputStream" shape="rect" coords="133,112,256,136"/>
  65. </map>
  66. </div></div>
  67. <table class="memberdecls">
  68. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  69. Public Member Functions</h2></td></tr>
  70. <tr class="memitem:a587bdb860accb89eca7945b8ad50bd40"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBinInputStream.html#a587bdb860accb89eca7945b8ad50bd40">~BinInputStream</a> ()</td></tr>
  71. <tr class="separator:a587bdb860accb89eca7945b8ad50bd40"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:a959a030c22785e3bcee6e7dd6800df71"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a7647261a546ac47bda863a51d24ad898">XMLFilePos</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBinInputStream.html#a959a030c22785e3bcee6e7dd6800df71">curPos</a> () const =0</td></tr>
  73. <tr class="separator:a959a030c22785e3bcee6e7dd6800df71"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:a2245666a5058c666d0238ea5e5b5334b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBinInputStream.html#a2245666a5058c666d0238ea5e5b5334b">readBytes</a> (<a class="el" href="XercesDefs_8hpp.html#a7470c7a32c59355685ebcd878a33f126">XMLByte</a> *const toFill, const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> maxToRead)=0</td></tr>
  75. <tr class="separator:a2245666a5058c666d0238ea5e5b5334b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:acb658844f9600ad353604bc403e74ff4"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBinInputStream.html#acb658844f9600ad353604bc403e74ff4">getContentType</a> () const =0</td></tr>
  77. <tr class="memdesc:acb658844f9600ad353604bc403e74ff4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the "out-of-band" content type for the data supplied by this input stream in the form of the media-type production (mime type with optional parameters such as encoding) as defined by the HTTP 1.1 specification. <a href="#acb658844f9600ad353604bc403e74ff4">More...</a><br /></td></tr>
  78. <tr class="separator:acb658844f9600ad353604bc403e74ff4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="inherit_header pub_methods_classXMemory"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classXMemory')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classXMemory.html">XMemory</a></td></tr>
  80. <tr class="memitem:a717678d9deadc627a41fe0dddede9f7f inherit pub_methods_classXMemory"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMemory.html#a717678d9deadc627a41fe0dddede9f7f">operator new</a> (size_t size)</td></tr>
  81. <tr class="memdesc:a717678d9deadc627a41fe0dddede9f7f inherit pub_methods_classXMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method overrides operator new. <a href="#a717678d9deadc627a41fe0dddede9f7f">More...</a><br /></td></tr>
  82. <tr class="separator:a717678d9deadc627a41fe0dddede9f7f inherit pub_methods_classXMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:ac3022fcc968c684a31c1e6a9ede83c10 inherit pub_methods_classXMemory"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMemory.html#ac3022fcc968c684a31c1e6a9ede83c10">operator new</a> (size_t size, <a class="el" href="classMemoryManager.html">MemoryManager</a> *memMgr)</td></tr>
  84. <tr class="memdesc:ac3022fcc968c684a31c1e6a9ede83c10 inherit pub_methods_classXMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method defines a custom operator new, that will use the provided memory manager to perform the allocation. <a href="#ac3022fcc968c684a31c1e6a9ede83c10">More...</a><br /></td></tr>
  85. <tr class="separator:ac3022fcc968c684a31c1e6a9ede83c10 inherit pub_methods_classXMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:aeaad885b799ac2188ffd28f76182339c inherit pub_methods_classXMemory"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMemory.html#aeaad885b799ac2188ffd28f76182339c">operator new</a> (size_t size, void *ptr)</td></tr>
  87. <tr class="memdesc:aeaad885b799ac2188ffd28f76182339c inherit pub_methods_classXMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method overrides placement operator new. <a href="#aeaad885b799ac2188ffd28f76182339c">More...</a><br /></td></tr>
  88. <tr class="separator:aeaad885b799ac2188ffd28f76182339c inherit pub_methods_classXMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a9da30f1601ea458908cbf150fc2f8f8b inherit pub_methods_classXMemory"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMemory.html#a9da30f1601ea458908cbf150fc2f8f8b">operator delete</a> (void *p)</td></tr>
  90. <tr class="memdesc:a9da30f1601ea458908cbf150fc2f8f8b inherit pub_methods_classXMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method overrides operator delete. <a href="#a9da30f1601ea458908cbf150fc2f8f8b">More...</a><br /></td></tr>
  91. <tr class="separator:a9da30f1601ea458908cbf150fc2f8f8b inherit pub_methods_classXMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a22efbc6459bdbe79f83b7791bba4d1f6 inherit pub_methods_classXMemory"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMemory.html#a22efbc6459bdbe79f83b7791bba4d1f6">operator delete</a> (void *p, <a class="el" href="classMemoryManager.html">MemoryManager</a> *memMgr)</td></tr>
  93. <tr class="memdesc:a22efbc6459bdbe79f83b7791bba4d1f6 inherit pub_methods_classXMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method provides a matching delete for the custom operator new. <a href="#a22efbc6459bdbe79f83b7791bba4d1f6">More...</a><br /></td></tr>
  94. <tr class="separator:a22efbc6459bdbe79f83b7791bba4d1f6 inherit pub_methods_classXMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:a32ee38b70d412e12f669cfbd86adf623 inherit pub_methods_classXMemory"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMemory.html#a32ee38b70d412e12f669cfbd86adf623">operator delete</a> (void *p, void *ptr)</td></tr>
  96. <tr class="memdesc:a32ee38b70d412e12f669cfbd86adf623 inherit pub_methods_classXMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method provides a matching delete for the placement new. <a href="#a32ee38b70d412e12f669cfbd86adf623">More...</a><br /></td></tr>
  97. <tr class="separator:a32ee38b70d412e12f669cfbd86adf623 inherit pub_methods_classXMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. </table><table class="memberdecls">
  99. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  100. Protected Member Functions</h2></td></tr>
  101. <tr class="memitem:ad62b19034fc2b05ddf8c958b9c822278"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBinInputStream.html#ad62b19034fc2b05ddf8c958b9c822278">BinInputStream</a> ()</td></tr>
  102. <tr class="separator:ad62b19034fc2b05ddf8c958b9c822278"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="inherit_header pro_methods_classXMemory"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classXMemory')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classXMemory.html">XMemory</a></td></tr>
  104. <tr class="memitem:ae5b8adaa10d5d9276b42823f47e06858 inherit pro_methods_classXMemory"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMemory.html#ae5b8adaa10d5d9276b42823f47e06858">XMemory</a> ()</td></tr>
  105. <tr class="memdesc:ae5b8adaa10d5d9276b42823f47e06858 inherit pro_methods_classXMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">Protected default constructor. <a href="#ae5b8adaa10d5d9276b42823f47e06858">More...</a><br /></td></tr>
  106. <tr class="separator:ae5b8adaa10d5d9276b42823f47e06858 inherit pro_methods_classXMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. </table>
  108. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  109. <a class="anchor" id="a587bdb860accb89eca7945b8ad50bd40"></a>
  110. <div class="memitem">
  111. <div class="memproto">
  112. <table class="mlabels">
  113. <tr>
  114. <td class="mlabels-left">
  115. <table class="memname">
  116. <tr>
  117. <td class="memname">virtual BinInputStream::~BinInputStream </td>
  118. <td>(</td>
  119. <td class="paramname"></td><td>)</td>
  120. <td></td>
  121. </tr>
  122. </table>
  123. </td>
  124. <td class="mlabels-right">
  125. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  126. </tr>
  127. </table>
  128. </div><div class="memdoc">
  129. </div>
  130. </div>
  131. <a class="anchor" id="ad62b19034fc2b05ddf8c958b9c822278"></a>
  132. <div class="memitem">
  133. <div class="memproto">
  134. <table class="mlabels">
  135. <tr>
  136. <td class="mlabels-left">
  137. <table class="memname">
  138. <tr>
  139. <td class="memname">BinInputStream::BinInputStream </td>
  140. <td>(</td>
  141. <td class="paramname"></td><td>)</td>
  142. <td></td>
  143. </tr>
  144. </table>
  145. </td>
  146. <td class="mlabels-right">
  147. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  148. </tr>
  149. </table>
  150. </div><div class="memdoc">
  151. </div>
  152. </div>
  153. <h2 class="groupheader">Member Function Documentation</h2>
  154. <a class="anchor" id="a959a030c22785e3bcee6e7dd6800df71"></a>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="mlabels">
  158. <tr>
  159. <td class="mlabels-left">
  160. <table class="memname">
  161. <tr>
  162. <td class="memname">virtual <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a7647261a546ac47bda863a51d24ad898">XMLFilePos</a> BinInputStream::curPos </td>
  163. <td>(</td>
  164. <td class="paramname"></td><td>)</td>
  165. <td> const</td>
  166. </tr>
  167. </table>
  168. </td>
  169. <td class="mlabels-right">
  170. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  171. </tr>
  172. </table>
  173. </div><div class="memdoc">
  174. <p>Implemented in <a class="el" href="classBinFileInputStream.html#a30d3c89d2f62768db8e9913b6a3a2dd4">BinFileInputStream</a>, and <a class="el" href="classBinMemInputStream.html#a16de7f8cb3aa38ad7233fb310c63929d">BinMemInputStream</a>.</p>
  175. </div>
  176. </div>
  177. <a class="anchor" id="acb658844f9600ad353604bc403e74ff4"></a>
  178. <div class="memitem">
  179. <div class="memproto">
  180. <table class="mlabels">
  181. <tr>
  182. <td class="mlabels-left">
  183. <table class="memname">
  184. <tr>
  185. <td class="memname">virtual const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a>* BinInputStream::getContentType </td>
  186. <td>(</td>
  187. <td class="paramname"></td><td>)</td>
  188. <td> const</td>
  189. </tr>
  190. </table>
  191. </td>
  192. <td class="mlabels-right">
  193. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  194. </tr>
  195. </table>
  196. </div><div class="memdoc">
  197. <p>Return the "out-of-band" content type for the data supplied by this input stream in the form of the media-type production (mime type with optional parameters such as encoding) as defined by the HTTP 1.1 specification. </p>
  198. <p>If no such content type is provided for the data, 0 is returned. This function is expected to return the correct value at any time after the construction of the stream.</p>
  199. <p>An example of the stream that may return non-0 from this function is an HTTP stream with the value returned taken from the "Content-Type" HTTP header. Note also that if the encoding of the data is known to the application by some other means then the setEncoding function in the <a class="el" href="classInputSource.html" title="A single input source for an XML entity. ">InputSource</a> object should be used instead. The getContentType function should only be used to return information that is intrinsic to the stream.</p>
  200. <dl class="section return"><dt>Returns</dt><dd>The content type, or 0 if one is not available. </dd></dl>
  201. <p>Implemented in <a class="el" href="classBinFileInputStream.html#a46e2bb0c28db13c9d82bc1167922ed5a">BinFileInputStream</a>, and <a class="el" href="classBinMemInputStream.html#a43ef21224f83f5c76c18d10dfb147d7b">BinMemInputStream</a>.</p>
  202. </div>
  203. </div>
  204. <a class="anchor" id="a2245666a5058c666d0238ea5e5b5334b"></a>
  205. <div class="memitem">
  206. <div class="memproto">
  207. <table class="mlabels">
  208. <tr>
  209. <td class="mlabels-left">
  210. <table class="memname">
  211. <tr>
  212. <td class="memname">virtual <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> BinInputStream::readBytes </td>
  213. <td>(</td>
  214. <td class="paramtype"><a class="el" href="XercesDefs_8hpp.html#a7470c7a32c59355685ebcd878a33f126">XMLByte</a> *const&#160;</td>
  215. <td class="paramname"><em>toFill</em>, </td>
  216. </tr>
  217. <tr>
  218. <td class="paramkey"></td>
  219. <td></td>
  220. <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a>&#160;</td>
  221. <td class="paramname"><em>maxToRead</em>&#160;</td>
  222. </tr>
  223. <tr>
  224. <td></td>
  225. <td>)</td>
  226. <td></td><td></td>
  227. </tr>
  228. </table>
  229. </td>
  230. <td class="mlabels-right">
  231. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  232. </tr>
  233. </table>
  234. </div><div class="memdoc">
  235. <p>Implemented in <a class="el" href="classBinFileInputStream.html#a2db44ccf62ffaa8355600aa8e8fb0f71">BinFileInputStream</a>, and <a class="el" href="classBinMemInputStream.html#afe5316fc9aa18d3cd581f016fbdbda7c">BinMemInputStream</a>.</p>
  236. </div>
  237. </div>
  238. <hr/>The documentation for this class was generated from the following file:<ul>
  239. <li><a class="el" href="BinInputStream_8hpp_source.html">BinInputStream.hpp</a></li>
  240. </ul>
  241. </div><!-- contents -->
  242. <!-- start footer part -->
  243. <hr class="footer"/><address class="footer"><small>
  244. Generated on Wed Mar 18 2015 10:43:37 for Xerces-C++ by &#160;<a href="http://www.doxygen.org/index.html">
  245. <img class="footer" src="doxygen.png" alt="doxygen"/>
  246. </a> 1.8.9.1
  247. </small></address>
  248. </body>
  249. </html>