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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>wxWidgets: wxStreamBase Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="page_container">
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0" style="width: 100%;">
<tbody>
<tr>
<td id="projectlogo">
<a href="http://www.wxwidgets.org/" target="_new">
<img alt="wxWidgets" src="logo.png"/>
</a>
</td>
<td style="padding-left: 0.5em; text-align: right;">
<span id="projectnumber">Version: 3.0.2</span>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.8.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Categories</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="classwx_stream_base-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">wxStreamBase Class Reference<div class="ingroups"><a class="el" href="group__group__class__streams.html">Streams</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <wx/stream.h></code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for wxStreamBase:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classwx_stream_base__inherit__graph.png" border="0" usemap="#wx_stream_base_inherit__map" alt="Inheritance graph"/></div>
<map name="wx_stream_base_inherit__map" id="wx_stream_base_inherit__map">
<area shape="rect" id="node3" href="classwx_input_stream.html" title="wxInputStream is an abstract base class which may not be used directly." alt="" coords="169,511,276,539"/><area shape="rect" id="node35" href="classwx_output_stream.html" title="wxOutputStream is an abstract base class which may not be used directly." alt="" coords="164,207,281,235"/><area shape="rect" id="node5" href="classwx_f_file_input_stream.html" title="This class represents data read in from a file." alt="" coords="349,410,485,438"/><area shape="rect" id="node9" href="classwx_file_input_stream.html" title="This class represents data read in from a file." alt="" coords="353,511,481,539"/><area shape="rect" id="node13" href="classwx_filter_input_stream.html" title="A filter stream has the capability of a normal stream but it can be placed on top of another stream..." alt="" coords="349,663,485,691"/><area shape="rect" id="node29" href="classwx_memory_input_stream.html" title="This class allows to use all methods taking a wxInputStream reference to read in-memory data..." alt="" coords="340,461,495,489"/><area shape="rect" id="node31" href="classwx_socket_input_stream.html" title="This class implements an input stream which reads data from a connected socket." alt="" coords="343,562,492,590"/><area shape="rect" id="node33" href="classwx_string_input_stream.html" title="This class implements an input stream which reads data from a string." alt="" coords="347,613,488,641"/><area shape="rect" id="node7" href="classwx_f_file_stream.html" title="This stream allows to both read from and write to a file using buffered STDIO functions." alt="" coords="581,347,688,375"/><area shape="rect" id="node11" href="classwx_file_stream.html" title="This class represents data that can be both read from and written to a file." alt="" coords="585,423,684,451"/><area shape="rect" id="node15" href="classwx_archive_input_stream.html" title="This is an abstract base class which serves as a common interface to archive input streams such as wx..." alt="" coords="560,638,709,666"/><area shape="rect" id="node21" href="classwx_buffered_input_stream.html" title="This stream acts as a cache." alt="" coords="557,689,712,717"/><area shape="rect" id="node23" href="classwx_wrapper_input_stream.html" title="A wrapper input stream is a kind of filter stream which forwards all the operations to its base strea..." alt="" coords="557,739,712,767"/><area shape="rect" id="node27" href="classwx_zlib_input_stream.html" title="This filter stream decompresses a stream that is in zlib or gzip format." alt="" coords="571,587,699,615"/><area shape="rect" id="node17" href="classwx_tar_input_stream.html" title="Input stream for reading tar files." alt="" coords="772,663,897,691"/><area shape="rect" id="node19" href="classwx_zip_input_stream.html" title="Input stream for reading zip files." alt="" coords="772,613,897,641"/><area shape="rect" id="node25" href="classwx_f_s_input_stream.html" title="Input stream for virtual file stream files." alt="" coords="772,739,897,767"/><area shape="rect" id="node37" href="classwx_counting_output_stream.html" title="wxCountingOutputStream is a specialized output stream which does not write any data anywhere..." alt="" coords="333,106,501,134"/><area shape="rect" id="node39" href="classwx_f_file_output_stream.html" title="This class represents data written to a file." alt="" coords="344,207,491,235"/><area shape="rect" id="node42" href="classwx_file_output_stream.html" title="This class represents data written to a file." alt="" coords="348,359,487,387"/><area shape="rect" id="node45" href="classwx_filter_output_stream.html" title="A filter stream has the capability of a normal stream but it can be placed on top of another stream..." alt="" coords="344,157,491,185"/><area shape="rect" id="node57" href="classwx_memory_output_stream.html" title="This class allows to use all methods taking a wxOutputStream reference to write to in-memory data..." alt="" coords="336,258,499,286"/><area shape="rect" id="node59" href="classwx_socket_output_stream.html" title="This class implements an output stream which writes data from a connected socket." alt="" coords="339,309,496,337"/><area shape="rect" id="node61" href="classwx_string_output_stream.html" title="This class implements an output stream which writes data either to a user-provided or internally allo..." alt="" coords="341,5,493,33"/><area shape="rect" id="node63" href="classwx_temp_file_output_stream.html" title="wxTempFileOutputStream is an output stream based on wxTempFile." alt="" coords="332,55,503,83"/><area shape="rect" id="node47" href="classwx_archive_output_stream.html" title="This is an abstract base class which serves as a common interface to archive output streams such as w..." alt="" coords="555,106,715,134"/><area shape="rect" id="node53" href="classwx_buffered_output_stream.html" title="This stream acts as a cache." alt="" coords="552,157,717,185"/><area shape="rect" id="node55" href="classwx_zlib_output_stream.html" title="This stream compresses all data written to it." alt="" coords="565,207,704,235"/><area shape="rect" id="node49" href="classwx_tar_output_stream.html" title="Output stream for writing tar files." alt="" coords="767,131,903,159"/><area shape="rect" id="node51" href="classwx_zip_output_stream.html" title="Output stream for writing zip files." alt="" coords="767,81,903,109"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class is the base class of most stream related classes in wxWidgets. </p>
<p>It must not be used directly.</p>
<h2></h2>
<div><span class="lib">Library:</span>  <span class="lib_text"><a class="el" href="page_libs.html#page_libs_wxbase">wxBase</a></span></div><div><span class="category">Category:</span>  <span class="category_text"><a class="el" href="group__group__class__streams.html">Streams</a></span></div><dl class="section see"><dt>See Also</dt><dd><a class="el" href="classwx_stream_buffer.html" title="wxStreamBuffer is a cache manager for wxStreamBase: it manages a stream buffer linked to a stream...">wxStreamBuffer</a> </dd></dl>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2bdb01f1ccd34d551d3cfc848054bf1e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_stream_base.html#a2bdb01f1ccd34d551d3cfc848054bf1e">wxStreamBase</a> ()</td></tr>
<tr class="memdesc:a2bdb01f1ccd34d551d3cfc848054bf1e"><td class="mdescLeft"> </td><td class="mdescRight">Creates a dummy stream object. <a href="#a2bdb01f1ccd34d551d3cfc848054bf1e"></a><br/></td></tr>
<tr class="separator:a2bdb01f1ccd34d551d3cfc848054bf1e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aebba32b4da79c60933fa997735a8bfe5"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_stream_base.html#aebba32b4da79c60933fa997735a8bfe5">~wxStreamBase</a> ()</td></tr>
<tr class="memdesc:aebba32b4da79c60933fa997735a8bfe5"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#aebba32b4da79c60933fa997735a8bfe5"></a><br/></td></tr>
<tr class="separator:aebba32b4da79c60933fa997735a8bfe5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aca7d52699887bc33bec4810bf6fe29ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interface_2wx_2stream_8h.html#a3f7d92141b5177ab9661bd8073940b2e">wxStreamError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_stream_base.html#aca7d52699887bc33bec4810bf6fe29ba">GetLastError</a> () const </td></tr>
<tr class="memdesc:aca7d52699887bc33bec4810bf6fe29ba"><td class="mdescLeft"> </td><td class="mdescRight">This function returns the last error. <a href="#aca7d52699887bc33bec4810bf6fe29ba"></a><br/></td></tr>
<tr class="separator:aca7d52699887bc33bec4810bf6fe29ba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0d2d992fd98835aabf2b9b656a1e6ccd"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__group__funcmacro__file.html#ga69d831b3febabc149c67b716c8e22de5">wxFileOffset</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_stream_base.html#a0d2d992fd98835aabf2b9b656a1e6ccd">GetLength</a> () const </td></tr>
<tr class="memdesc:a0d2d992fd98835aabf2b9b656a1e6ccd"><td class="mdescLeft"> </td><td class="mdescRight">Returns the length of the stream in bytes. <a href="#a0d2d992fd98835aabf2b9b656a1e6ccd"></a><br/></td></tr>
<tr class="separator:a0d2d992fd98835aabf2b9b656a1e6ccd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6ca6e81329a81252c50ccba1ee9249d8"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_stream_base.html#a6ca6e81329a81252c50ccba1ee9249d8">GetSize</a> () const </td></tr>
<tr class="memdesc:a6ca6e81329a81252c50ccba1ee9249d8"><td class="mdescLeft"> </td><td class="mdescRight">This function returns the size of the stream. <a href="#a6ca6e81329a81252c50ccba1ee9249d8"></a><br/></td></tr>
<tr class="separator:a6ca6e81329a81252c50ccba1ee9249d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a40b8d76951fdbc283a312ad8c12cfe9b"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_stream_base.html#a40b8d76951fdbc283a312ad8c12cfe9b">IsOk</a> () const </td></tr>
<tr class="memdesc:a40b8d76951fdbc283a312ad8c12cfe9b"><td class="mdescLeft"> </td><td class="mdescRight">Returns <span class="literal">true</span> if no error occurred on the stream. <a href="#a40b8d76951fdbc283a312ad8c12cfe9b"></a><br/></td></tr>
<tr class="separator:a40b8d76951fdbc283a312ad8c12cfe9b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b575329128f8ec7a369c9b2f7593d93"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_stream_base.html#a1b575329128f8ec7a369c9b2f7593d93">IsSeekable</a> () const </td></tr>
<tr class="memdesc:a1b575329128f8ec7a369c9b2f7593d93"><td class="mdescLeft"> </td><td class="mdescRight">Returns <span class="literal">true</span> if the stream supports seeking to arbitrary offsets. <a href="#a1b575329128f8ec7a369c9b2f7593d93"></a><br/></td></tr>
<tr class="separator:a1b575329128f8ec7a369c9b2f7593d93"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a52353ac42f72538b2022a84f416e5fe2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_stream_base.html#a52353ac42f72538b2022a84f416e5fe2">Reset</a> (<a class="el" href="interface_2wx_2stream_8h.html#a3f7d92141b5177ab9661bd8073940b2e">wxStreamError</a> error=<a class="el" href="interface_2wx_2stream_8h.html#a3f7d92141b5177ab9661bd8073940b2ea1815acdbaf8a17d9159633e71bb69150">wxSTREAM_NO_ERROR</a>)</td></tr>
<tr class="memdesc:a52353ac42f72538b2022a84f416e5fe2"><td class="mdescLeft"> </td><td class="mdescRight">Resets the stream state. <a href="#a52353ac42f72538b2022a84f416e5fe2"></a><br/></td></tr>
<tr class="separator:a52353ac42f72538b2022a84f416e5fe2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaee699fe59f603eaae1550ee55ac579f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_stream_base.html#aaee699fe59f603eaae1550ee55ac579f">operator!</a> () const </td></tr>
<tr class="memdesc:aaee699fe59f603eaae1550ee55ac579f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the opposite of <a class="el" href="classwx_stream_base.html#a40b8d76951fdbc283a312ad8c12cfe9b" title="Returns true if no error occurred on the stream.">IsOk()</a>. <a href="#aaee699fe59f603eaae1550ee55ac579f"></a><br/></td></tr>
<tr class="separator:aaee699fe59f603eaae1550ee55ac579f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ae38e82c374f82d39993909f0a5d3017e"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__group__funcmacro__file.html#ga69d831b3febabc149c67b716c8e22de5">wxFileOffset</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_stream_base.html#ae38e82c374f82d39993909f0a5d3017e">OnSysSeek</a> (<a class="el" href="group__group__funcmacro__file.html#ga69d831b3febabc149c67b716c8e22de5">wxFileOffset</a> pos, <a class="el" href="group__group__funcmacro__file.html#gae3981f8632f0391e5c852bf62eb982b0">wxSeekMode</a> mode)</td></tr>
<tr class="memdesc:ae38e82c374f82d39993909f0a5d3017e"><td class="mdescLeft"> </td><td class="mdescRight">Internal function. <a href="#ae38e82c374f82d39993909f0a5d3017e"></a><br/></td></tr>
<tr class="separator:ae38e82c374f82d39993909f0a5d3017e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7bb3b0b470e960d1165a28e83d576c1b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__group__funcmacro__file.html#ga69d831b3febabc149c67b716c8e22de5">wxFileOffset</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_stream_base.html#a7bb3b0b470e960d1165a28e83d576c1b">OnSysTell</a> () const </td></tr>
<tr class="memdesc:a7bb3b0b470e960d1165a28e83d576c1b"><td class="mdescLeft"> </td><td class="mdescRight">Internal function. <a href="#a7bb3b0b470e960d1165a28e83d576c1b"></a><br/></td></tr>
<tr class="separator:a7bb3b0b470e960d1165a28e83d576c1b"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a2bdb01f1ccd34d551d3cfc848054bf1e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxStreamBase::wxStreamBase </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a dummy stream object. </p>
<p>It doesn't do anything. </p>
</div>
</div>
<a class="anchor" id="aebba32b4da79c60933fa997735a8bfe5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual wxStreamBase::~wxStreamBase </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aca7d52699887bc33bec4810bf6fe29ba"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="interface_2wx_2stream_8h.html#a3f7d92141b5177ab9661bd8073940b2e">wxStreamError</a> wxStreamBase::GetLastError </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>This function returns the last error. </p>
</div>
</div>
<a class="anchor" id="a0d2d992fd98835aabf2b9b656a1e6ccd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__group__funcmacro__file.html#ga69d831b3febabc149c67b716c8e22de5">wxFileOffset</a> wxStreamBase::GetLength </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the length of the stream in bytes. </p>
<p>If the length cannot be determined (this is always the case for socket streams for example), returns <a class="el" href="group__group__funcmacro__file.html#gab184c7199d93541d22ae42e515cbbcb7" title="A special return value of many wxWidgets classes to indicate that an invalid offset was given...">wxInvalidOffset</a>.</p>
<dl class="section since"><dt>Since</dt><dd>2.5.4 </dd></dl>
<p>Reimplemented in <a class="el" href="classwx_counting_output_stream.html#ade56287c14d2f85a3bb784ab7e177099">wxCountingOutputStream</a>.</p>
</div>
</div>
<a class="anchor" id="a6ca6e81329a81252c50ccba1ee9249d8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t wxStreamBase::GetSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This function returns the size of the stream. </p>
<p>For example, for a file it is the size of the file.</p>
<dl class="section warning"><dt>Warning</dt><dd>There are streams which do not have size by definition, such as socket streams. In that cases, <a class="el" href="classwx_stream_base.html#a6ca6e81329a81252c50ccba1ee9249d8" title="This function returns the size of the stream.">GetSize()</a> returns 0 so you should always test its return value. </dd></dl>
</div>
</div>
<a class="anchor" id="a40b8d76951fdbc283a312ad8c12cfe9b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool wxStreamBase::IsOk </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns <span class="literal">true</span> if no error occurred on the stream. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classwx_stream_base.html#aca7d52699887bc33bec4810bf6fe29ba" title="This function returns the last error.">GetLastError()</a> </dd></dl>
<p>Reimplemented in <a class="el" href="classwx_f_s_input_stream.html#abfa73b8c605632017a3f29bb79832cc3">wxFSInputStream</a>, <a class="el" href="classwx_file_stream.html#aef7a2de6574ce8d0d06cf2c1005c41ec">wxFileStream</a>, <a class="el" href="classwx_f_file_stream.html#a581764177f50174c1835f6837f3d68ba">wxFFileStream</a>, <a class="el" href="classwx_f_file_input_stream.html#a52eb6ea3010214e391f5e940371b5ed8">wxFFileInputStream</a>, <a class="el" href="classwx_file_input_stream.html#aa519cd42e768e05dedccd55e1ac1e969">wxFileInputStream</a>, <a class="el" href="classwx_file_output_stream.html#a626753e0830d6c9c5acc91f3cfe0127e">wxFileOutputStream</a>, and <a class="el" href="classwx_f_file_output_stream.html#a60c639530e2197b9563e743981427f72">wxFFileOutputStream</a>.</p>
</div>
</div>
<a class="anchor" id="a1b575329128f8ec7a369c9b2f7593d93"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool wxStreamBase::IsSeekable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns <span class="literal">true</span> if the stream supports seeking to arbitrary offsets. </p>
</div>
</div>
<a class="anchor" id="ae38e82c374f82d39993909f0a5d3017e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__group__funcmacro__file.html#ga69d831b3febabc149c67b716c8e22de5">wxFileOffset</a> wxStreamBase::OnSysSeek </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__group__funcmacro__file.html#ga69d831b3febabc149c67b716c8e22de5">wxFileOffset</a> </td>
<td class="paramname"><em>pos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__group__funcmacro__file.html#gae3981f8632f0391e5c852bf62eb982b0">wxSeekMode</a> </td>
<td class="paramname"><em>mode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Internal function. </p>
<p>It is called when the stream needs to change the current position.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pos</td><td>Offset to seek to. </td></tr>
<tr><td class="paramname">mode</td><td>One of the <a class="el" href="group__group__funcmacro__file.html#gae3981f8632f0391e5c852bf62eb982b0" title="Parameter indicating how file offset should be interpreted.">wxSeekMode</a> enumeration values.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The new stream position or <a class="el" href="group__group__funcmacro__file.html#gab184c7199d93541d22ae42e515cbbcb7" title="A special return value of many wxWidgets classes to indicate that an invalid offset was given...">wxInvalidOffset</a> on error. </dd></dl>
</div>
</div>
<a class="anchor" id="a7bb3b0b470e960d1165a28e83d576c1b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__group__funcmacro__file.html#ga69d831b3febabc149c67b716c8e22de5">wxFileOffset</a> wxStreamBase::OnSysTell </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Internal function. </p>
<p>It is called when the stream needs to know the real position.</p>
<dl class="section return"><dt>Returns</dt><dd>The current stream position. </dd></dl>
</div>
</div>
<a class="anchor" id="aaee699fe59f603eaae1550ee55ac579f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxStreamBase::operator! </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the opposite of <a class="el" href="classwx_stream_base.html#a40b8d76951fdbc283a312ad8c12cfe9b" title="Returns true if no error occurred on the stream.">IsOk()</a>. </p>
<p>You can use this function to test the validity of the stream as if it was a pointer:</p>
<div class="fragment"><div class="line"><span class="keywordtype">bool</span> DoSomething(<a class="code" href="classwx_input_stream.html" title="wxInputStream is an abstract base class which may not be used directly.">wxInputStream</a>& stream)</div>
<div class="line">{</div>
<div class="line"> <a class="code" href="defs_8h.html#a5c084575ef1ffaa7586dda7e4b22d78a" title="32 bit type (the mapping is more complex than a simple typedef and is not shown here).">wxInt32</a> data;</div>
<div class="line"> <span class="keywordflow">if</span> (!stream.<a class="code" href="classwx_input_stream.html#a72f24d0f50c7f07bb68dedf5e8690f4e" title="Reads the specified amount of bytes and stores the data in buffer.">Read</a>(&data, 4))</div>
<div class="line"> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"> ...</div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="a52353ac42f72538b2022a84f416e5fe2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wxStreamBase::Reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="interface_2wx_2stream_8h.html#a3f7d92141b5177ab9661bd8073940b2e">wxStreamError</a> </td>
<td class="paramname"><em>error</em> = <code><a class="el" href="interface_2wx_2stream_8h.html#a3f7d92141b5177ab9661bd8073940b2ea1815acdbaf8a17d9159633e71bb69150">wxSTREAM_NO_ERROR</a></code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets the stream state. </p>
<p>By default, resets the stream to good state, i.e. clears any errors. Since wxWidgets 2.9.3 can be also used to explicitly set the state to the specified error (the <em>error</em> argument didn't exist in the previous versions).</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classwx_stream_base.html#aca7d52699887bc33bec4810bf6fe29ba" title="This function returns the last error.">GetLastError()</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
<address class="footer">
<small>
Generated on Thu Nov 27 2014 13:46:59 for wxWidgets by <a href="http://www.doxygen.org/index.html" target="_new">Doxygen</a> 1.8.2
</small>
</address>
<script src="wxwidgets.js" type="text/javascript"></script>
</div><!-- #page_container -->
</body>
</html>
|
