1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Xerces-C++: BinInputStream Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>BinInputStream Class Reference</h1><!-- doxytag: class="BinInputStream" --><!-- doxytag: inherits="XMemory" --><div class="dynheader">
Inheritance diagram for BinInputStream:</div>
<div class="dynsection">
<p><center><img src="classBinInputStream.png" usemap="#BinInputStream_map" border="0" alt=""></center>
<map name="BinInputStream_map">
<area href="classXMemory.html" alt="XMemory" shape="rect" coords="66,0,189,24">
<area href="classBinFileInputStream.html" alt="BinFileInputStream" shape="rect" coords="0,112,123,136">
<area href="classBinMemInputStream.html" alt="BinMemInputStream" shape="rect" coords="133,112,256,136">
</map>
</div>
<p>
<a href="classBinInputStream-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinInputStream.html#587bdb860accb89eca7945b8ad50bd40">~BinInputStream</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#7647261a546ac47bda863a51d24ad898">XMLFilePos</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinInputStream.html#959a030c22785e3bcee6e7dd6800df71">curPos</a> () const =0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinInputStream.html#2245666a5058c666d0238ea5e5b5334b">readBytes</a> (<a class="el" href="XercesDefs_8hpp.html#7470c7a32c59355685ebcd878a33f126">XMLByte</a> *const toFill, const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> maxToRead)=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinInputStream.html#cb658844f9600ad353604bc403e74ff4">getContentType</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </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="#cb658844f9600ad353604bc403e74ff4"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinInputStream.html#d62b19034fc2b05ddf8c958b9c822278">BinInputStream</a> ()</td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="587bdb860accb89eca7945b8ad50bd40"></a><!-- doxytag: member="BinInputStream::~BinInputStream" ref="587bdb860accb89eca7945b8ad50bd40" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual BinInputStream::~BinInputStream </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="d62b19034fc2b05ddf8c958b9c822278"></a><!-- doxytag: member="BinInputStream::BinInputStream" ref="d62b19034fc2b05ddf8c958b9c822278" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BinInputStream::BinInputStream </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="959a030c22785e3bcee6e7dd6800df71"></a><!-- doxytag: member="BinInputStream::curPos" ref="959a030c22785e3bcee6e7dd6800df71" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#7647261a546ac47bda863a51d24ad898">XMLFilePos</a> BinInputStream::curPos </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Implemented in <a class="el" href="classBinFileInputStream.html#30d3c89d2f62768db8e9913b6a3a2dd4">BinFileInputStream</a>, and <a class="el" href="classBinMemInputStream.html#16de7f8cb3aa38ad7233fb310c63929d">BinMemInputStream</a>.</p>
</div>
</div><p>
<a class="anchor" name="2245666a5058c666d0238ea5e5b5334b"></a><!-- doxytag: member="BinInputStream::readBytes" ref="2245666a5058c666d0238ea5e5b5334b" args="(XMLByte *const toFill, const XMLSize_t maxToRead)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> BinInputStream::readBytes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="XercesDefs_8hpp.html#7470c7a32c59355685ebcd878a33f126">XMLByte</a> *const </td>
<td class="paramname"> <em>toFill</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> </td>
<td class="paramname"> <em>maxToRead</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Implemented in <a class="el" href="classBinFileInputStream.html#2db44ccf62ffaa8355600aa8e8fb0f71">BinFileInputStream</a>, and <a class="el" href="classBinMemInputStream.html#fe5316fc9aa18d3cd581f016fbdbda7c">BinMemInputStream</a>.</p>
</div>
</div><p>
<a class="anchor" name="cb658844f9600ad353604bc403e74ff4"></a><!-- doxytag: member="BinInputStream::getContentType" ref="cb658844f9600ad353604bc403e74ff4" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a>* BinInputStream::getContentType </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
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>
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>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The content type, or 0 if one is not available. </dd></dl>
<p>Implemented in <a class="el" href="classBinFileInputStream.html#46e2bb0c28db13c9d82bc1167922ed5a">BinFileInputStream</a>, and <a class="el" href="classBinMemInputStream.html#43ef21224f83f5c76c18d10dfb147d7b">BinMemInputStream</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="BinInputStream_8hpp-source.html">BinInputStream.hpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Apr 21 17:55:49 2010 for Xerces-C++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
|