← Back to branch summary

~ubuntu-branches/ubuntu/precise/xerces-c/precise

« back to all changes in this revision

Viewing changes to doc/html/apiDocs-3/classBinFileInputStream.html

  • Committer: Bazaar Package Importer
  • Author(s): Jay Berkenbilt
  • Date: 2009-02-22 16:52:23 UTC
  • Revision ID: james.westby@ubuntu.com-20090222165223-klimp8u8m73yn9zp
Tags: upstream-3.0.1
Import upstream version 3.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/apiDocs-3/classBinFileInputStream.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
 
3
<title>Xerces-C++: BinFileInputStream Class Reference</title>
 
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
 
5
<link href="tabs.css" rel="stylesheet" type="text/css">
 
6
</head><body>
 
7
<!-- Generated by Doxygen 1.5.4 -->
 
8
<div class="tabs">
 
9
  <ul>
 
10
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
 
11
    <li class="current"><a href="classes.html"><span>Classes</span></a></li>
 
12
    <li><a href="files.html"><span>Files</span></a></li>
 
13
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
 
14
  </ul>
 
15
</div>
 
16
<div class="tabs">
 
17
  <ul>
 
18
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
 
19
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
 
20
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
 
21
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
 
22
  </ul>
 
23
</div>
 
24
<h1>BinFileInputStream Class Reference</h1><!-- doxytag: class="BinFileInputStream" --><!-- doxytag: inherits="BinInputStream" --><div class="dynheader">
 
25
Inheritance diagram for BinFileInputStream:</div>
 
26
<div class="dynsection">
 
27
 
 
28
<p><center><img src="classBinFileInputStream.png" usemap="#BinFileInputStream_map" border="0" alt=""></center>
 
29
<map name="BinFileInputStream_map">
 
30
<area href="classBinInputStream.html" alt="BinInputStream" shape="rect" coords="0,56,117,80">
 
31
<area href="classXMemory.html" alt="XMemory" shape="rect" coords="0,0,117,24">
 
32
</map>
 
33
</div>
 
34
 
 
35
<p>
 
36
<a href="classBinFileInputStream-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
 
37
<tr><td></td></tr>
 
38
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
 
39
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBinFileInputStream.html#721189e5e1da6861dbef834d738b96fd">BinFileInputStream</a> (const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a> *const fileName, <a class="el" href="classMemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classXMLPlatformUtils.html#97eff0d9fff3567bea3acd3ca4d95252">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
 
40
 
 
41
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBinFileInputStream.html#46065c9426ec8049fce64161d002d7d4">BinFileInputStream</a> (const char *const fileName, <a class="el" href="classMemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classXMLPlatformUtils.html#97eff0d9fff3567bea3acd3ca4d95252">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
 
42
 
 
43
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBinFileInputStream.html#615d34451ccfc5f5f629c1b8c7551d8f">BinFileInputStream</a> (const <a class="el" href="XMLFileMgr_8hpp.html#6738b6a1cc86fbf4c231eac94e357446">FileHandle</a> toUse, <a class="el" href="classMemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classXMLPlatformUtils.html#97eff0d9fff3567bea3acd3ca4d95252">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
 
44
 
 
45
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBinFileInputStream.html#c2f4e26c5a4177644508e91648709c56">~BinFileInputStream</a> ()</td></tr>
 
46
 
 
47
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBinFileInputStream.html#ef94117b67875be1d8dc286f946ce8f4">getIsOpen</a> () const </td></tr>
 
48
 
 
49
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#7647261a546ac47bda863a51d24ad898">XMLFilePos</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBinFileInputStream.html#f388f675fb391bfd4da38c7633416dca">getSize</a> () const </td></tr>
 
50
 
 
51
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBinFileInputStream.html#c4fce590c26a905a2a952ce65e15380c">reset</a> ()</td></tr>
 
52
 
 
53
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#7647261a546ac47bda863a51d24ad898">XMLFilePos</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBinFileInputStream.html#30d3c89d2f62768db8e9913b6a3a2dd4">curPos</a> () const </td></tr>
 
54
 
 
55
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBinFileInputStream.html#2db44ccf62ffaa8355600aa8e8fb0f71">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)</td></tr>
 
56
 
 
57
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBinFileInputStream.html#46e2bb0c28db13c9d82bc1167922ed5a">getContentType</a> () const </td></tr>
 
58
 
 
59
<tr><td class="mdescLeft">&nbsp;</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="#46e2bb0c28db13c9d82bc1167922ed5a"></a><br></td></tr>
 
60
</table>
 
61
<hr><h2>Constructor &amp; Destructor Documentation</h2>
 
62
<a class="anchor" name="721189e5e1da6861dbef834d738b96fd"></a><!-- doxytag: member="BinFileInputStream::BinFileInputStream" ref="721189e5e1da6861dbef834d738b96fd" args="(const XMLCh *const fileName, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
 
63
<div class="memitem">
 
64
<div class="memproto">
 
65
      <table class="memname">
 
66
        <tr>
 
67
          <td class="memname">BinFileInputStream::BinFileInputStream           </td>
 
68
          <td>(</td>
 
69
          <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a> *const &nbsp;</td>
 
70
          <td class="paramname"> <em>fileName</em>, </td>
 
71
        </tr>
 
72
        <tr>
 
73
          <td class="paramkey"></td>
 
74
          <td></td>
 
75
          <td class="paramtype"><a class="el" href="classMemoryManager.html">MemoryManager</a> *const &nbsp;</td>
 
76
          <td class="paramname"> <em>manager</em> = <code><a class="el" href="classXMLPlatformUtils.html#97eff0d9fff3567bea3acd3ca4d95252">XMLPlatformUtils::fgMemoryManager</a></code></td><td>&nbsp;</td>
 
77
        </tr>
 
78
        <tr>
 
79
          <td></td>
 
80
          <td>)</td>
 
81
          <td></td><td></td><td width="100%"></td>
 
82
        </tr>
 
83
      </table>
 
84
</div>
 
85
<div class="memdoc">
 
86
 
 
87
<p>
 
88
 
 
89
</div>
 
90
</div><p>
 
91
<a class="anchor" name="46065c9426ec8049fce64161d002d7d4"></a><!-- doxytag: member="BinFileInputStream::BinFileInputStream" ref="46065c9426ec8049fce64161d002d7d4" args="(const char *const fileName, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
 
92
<div class="memitem">
 
93
<div class="memproto">
 
94
      <table class="memname">
 
95
        <tr>
 
96
          <td class="memname">BinFileInputStream::BinFileInputStream           </td>
 
97
          <td>(</td>
 
98
          <td class="paramtype">const char *const &nbsp;</td>
 
99
          <td class="paramname"> <em>fileName</em>, </td>
 
100
        </tr>
 
101
        <tr>
 
102
          <td class="paramkey"></td>
 
103
          <td></td>
 
104
          <td class="paramtype"><a class="el" href="classMemoryManager.html">MemoryManager</a> *const &nbsp;</td>
 
105
          <td class="paramname"> <em>manager</em> = <code><a class="el" href="classXMLPlatformUtils.html#97eff0d9fff3567bea3acd3ca4d95252">XMLPlatformUtils::fgMemoryManager</a></code></td><td>&nbsp;</td>
 
106
        </tr>
 
107
        <tr>
 
108
          <td></td>
 
109
          <td>)</td>
 
110
          <td></td><td></td><td width="100%"></td>
 
111
        </tr>
 
112
      </table>
 
113
</div>
 
114
<div class="memdoc">
 
115
 
 
116
<p>
 
117
 
 
118
</div>
 
119
</div><p>
 
120
<a class="anchor" name="615d34451ccfc5f5f629c1b8c7551d8f"></a><!-- doxytag: member="BinFileInputStream::BinFileInputStream" ref="615d34451ccfc5f5f629c1b8c7551d8f" args="(const FileHandle toUse, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
 
121
<div class="memitem">
 
122
<div class="memproto">
 
123
      <table class="memname">
 
124
        <tr>
 
125
          <td class="memname">BinFileInputStream::BinFileInputStream           </td>
 
126
          <td>(</td>
 
127
          <td class="paramtype">const <a class="el" href="XMLFileMgr_8hpp.html#6738b6a1cc86fbf4c231eac94e357446">FileHandle</a>&nbsp;</td>
 
128
          <td class="paramname"> <em>toUse</em>, </td>
 
129
        </tr>
 
130
        <tr>
 
131
          <td class="paramkey"></td>
 
132
          <td></td>
 
133
          <td class="paramtype"><a class="el" href="classMemoryManager.html">MemoryManager</a> *const &nbsp;</td>
 
134
          <td class="paramname"> <em>manager</em> = <code><a class="el" href="classXMLPlatformUtils.html#97eff0d9fff3567bea3acd3ca4d95252">XMLPlatformUtils::fgMemoryManager</a></code></td><td>&nbsp;</td>
 
135
        </tr>
 
136
        <tr>
 
137
          <td></td>
 
138
          <td>)</td>
 
139
          <td></td><td></td><td width="100%"></td>
 
140
        </tr>
 
141
      </table>
 
142
</div>
 
143
<div class="memdoc">
 
144
 
 
145
<p>
 
146
 
 
147
</div>
 
148
</div><p>
 
149
<a class="anchor" name="c2f4e26c5a4177644508e91648709c56"></a><!-- doxytag: member="BinFileInputStream::~BinFileInputStream" ref="c2f4e26c5a4177644508e91648709c56" args="()" -->
 
150
<div class="memitem">
 
151
<div class="memproto">
 
152
      <table class="memname">
 
153
        <tr>
 
154
          <td class="memname">virtual BinFileInputStream::~BinFileInputStream           </td>
 
155
          <td>(</td>
 
156
          <td class="paramname">          </td>
 
157
          <td>&nbsp;)&nbsp;</td>
 
158
          <td width="100%"><code> [virtual]</code></td>
 
159
        </tr>
 
160
      </table>
 
161
</div>
 
162
<div class="memdoc">
 
163
 
 
164
<p>
 
165
 
 
166
</div>
 
167
</div><p>
 
168
<hr><h2>Member Function Documentation</h2>
 
169
<a class="anchor" name="ef94117b67875be1d8dc286f946ce8f4"></a><!-- doxytag: member="BinFileInputStream::getIsOpen" ref="ef94117b67875be1d8dc286f946ce8f4" args="() const " -->
 
170
<div class="memitem">
 
171
<div class="memproto">
 
172
      <table class="memname">
 
173
        <tr>
 
174
          <td class="memname">bool BinFileInputStream::getIsOpen           </td>
 
175
          <td>(</td>
 
176
          <td class="paramname">          </td>
 
177
          <td>&nbsp;)&nbsp;</td>
 
178
          <td width="100%"> const</td>
 
179
        </tr>
 
180
      </table>
 
181
</div>
 
182
<div class="memdoc">
 
183
 
 
184
<p>
 
185
 
 
186
</div>
 
187
</div><p>
 
188
<a class="anchor" name="f388f675fb391bfd4da38c7633416dca"></a><!-- doxytag: member="BinFileInputStream::getSize" ref="f388f675fb391bfd4da38c7633416dca" args="() const " -->
 
189
<div class="memitem">
 
190
<div class="memproto">
 
191
      <table class="memname">
 
192
        <tr>
 
193
          <td class="memname"><a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#7647261a546ac47bda863a51d24ad898">XMLFilePos</a> BinFileInputStream::getSize           </td>
 
194
          <td>(</td>
 
195
          <td class="paramname">          </td>
 
196
          <td>&nbsp;)&nbsp;</td>
 
197
          <td width="100%"> const</td>
 
198
        </tr>
 
199
      </table>
 
200
</div>
 
201
<div class="memdoc">
 
202
 
 
203
<p>
 
204
 
 
205
</div>
 
206
</div><p>
 
207
<a class="anchor" name="c4fce590c26a905a2a952ce65e15380c"></a><!-- doxytag: member="BinFileInputStream::reset" ref="c4fce590c26a905a2a952ce65e15380c" args="()" -->
 
208
<div class="memitem">
 
209
<div class="memproto">
 
210
      <table class="memname">
 
211
        <tr>
 
212
          <td class="memname">void BinFileInputStream::reset           </td>
 
213
          <td>(</td>
 
214
          <td class="paramname">          </td>
 
215
          <td>&nbsp;)&nbsp;</td>
 
216
          <td width="100%"></td>
 
217
        </tr>
 
218
      </table>
 
219
</div>
 
220
<div class="memdoc">
 
221
 
 
222
<p>
 
223
 
 
224
</div>
 
225
</div><p>
 
226
<a class="anchor" name="30d3c89d2f62768db8e9913b6a3a2dd4"></a><!-- doxytag: member="BinFileInputStream::curPos" ref="30d3c89d2f62768db8e9913b6a3a2dd4" args="() const " -->
 
227
<div class="memitem">
 
228
<div class="memproto">
 
229
      <table class="memname">
 
230
        <tr>
 
231
          <td class="memname">virtual <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#7647261a546ac47bda863a51d24ad898">XMLFilePos</a> BinFileInputStream::curPos           </td>
 
232
          <td>(</td>
 
233
          <td class="paramname">          </td>
 
234
          <td>&nbsp;)&nbsp;</td>
 
235
          <td width="100%"> const<code> [virtual]</code></td>
 
236
        </tr>
 
237
      </table>
 
238
</div>
 
239
<div class="memdoc">
 
240
 
 
241
<p>
 
242
 
 
243
<p>Implements <a class="el" href="classBinInputStream.html#959a030c22785e3bcee6e7dd6800df71">BinInputStream</a>.</p>
 
244
 
 
245
</div>
 
246
</div><p>
 
247
<a class="anchor" name="2db44ccf62ffaa8355600aa8e8fb0f71"></a><!-- doxytag: member="BinFileInputStream::readBytes" ref="2db44ccf62ffaa8355600aa8e8fb0f71" args="(XMLByte *const toFill, const XMLSize_t maxToRead)" -->
 
248
<div class="memitem">
 
249
<div class="memproto">
 
250
      <table class="memname">
 
251
        <tr>
 
252
          <td class="memname">virtual <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> BinFileInputStream::readBytes           </td>
 
253
          <td>(</td>
 
254
          <td class="paramtype"><a class="el" href="XercesDefs_8hpp.html#7470c7a32c59355685ebcd878a33f126">XMLByte</a> *const &nbsp;</td>
 
255
          <td class="paramname"> <em>toFill</em>, </td>
 
256
        </tr>
 
257
        <tr>
 
258
          <td class="paramkey"></td>
 
259
          <td></td>
 
260
          <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a>&nbsp;</td>
 
261
          <td class="paramname"> <em>maxToRead</em></td><td>&nbsp;</td>
 
262
        </tr>
 
263
        <tr>
 
264
          <td></td>
 
265
          <td>)</td>
 
266
          <td></td><td></td><td width="100%"><code> [virtual]</code></td>
 
267
        </tr>
 
268
      </table>
 
269
</div>
 
270
<div class="memdoc">
 
271
 
 
272
<p>
 
273
 
 
274
<p>Implements <a class="el" href="classBinInputStream.html#2245666a5058c666d0238ea5e5b5334b">BinInputStream</a>.</p>
 
275
 
 
276
</div>
 
277
</div><p>
 
278
<a class="anchor" name="46e2bb0c28db13c9d82bc1167922ed5a"></a><!-- doxytag: member="BinFileInputStream::getContentType" ref="46e2bb0c28db13c9d82bc1167922ed5a" args="() const " -->
 
279
<div class="memitem">
 
280
<div class="memproto">
 
281
      <table class="memname">
 
282
        <tr>
 
283
          <td class="memname">virtual const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a>* BinFileInputStream::getContentType           </td>
 
284
          <td>(</td>
 
285
          <td class="paramname">          </td>
 
286
          <td>&nbsp;)&nbsp;</td>
 
287
          <td width="100%"> const<code> [virtual]</code></td>
 
288
        </tr>
 
289
      </table>
 
290
</div>
 
291
<div class="memdoc">
 
292
 
 
293
<p>
 
294
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. 
 
295
<p>
 
296
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>
 
297
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>
 
298
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The content type, or 0 if one is not available. </dd></dl>
 
299
 
 
300
<p>Implements <a class="el" href="classBinInputStream.html#cb658844f9600ad353604bc403e74ff4">BinInputStream</a>.</p>
 
301
 
 
302
</div>
 
303
</div><p>
 
304
<hr>The documentation for this class was generated from the following file:<ul>
 
305
<li><a class="el" href="BinFileInputStream_8hpp-source.html">BinFileInputStream.hpp</a></ul>
 
306
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 18 07:56:10 2009 for Xerces-C++ by&nbsp;
 
307
<a href="http://www.doxygen.org/index.html">
 
308
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address>
 
309
</body>
 
310
</html>