1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" />
7    <style type="text/css"><!--
8      span.static_style
9      {
10        font-size			: 8pt;
11        color				: white;
12        font-weight			: bold;
13        background			: #44f;
14        border-left			: solid 1px #aaf;
15        border-top			: solid 1px #aaf;
16        border-right		: solid 1px #00c;
17        border-bottom		: solid 1px #00c;
18        padding-left		: 2px;
19        padding-right		: 2px;
20      }
21      span.virtual_style
22      {
23        font-size			 : 8pt;
24        color				 : white;
25        font-weight			: bold;
26        background			: #0a0;
27        border-left			: solid 1px #0f0;
28        border-top			: solid 1px #0f0;
29        border-right		: solid 1px #060;
30        border-bottom		: solid 1px #060;
31        padding-left		: 2px;
32        padding-right		: 2px;
33      }
34      span.protected_style
35      {
36        font-size			 : 8pt;
37        color				 : white;
38        font-weight			: bold;
39        background			: #444;
40        border-left			: solid 1px #ccc;
41        border-top			: solid 1px #ccc;
42        border-right		: solid 1px #222;
43        border-bottom		: solid 1px #222;
44        padding-left		: 2px;
45        padding-right		: 2px;
46      }
47        --></style>
48    <title>nw::io::FileStream</title>
49  </head>
50  <body>
51    <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/io/Overview.html">io</a>::FileStream</CODE> Class</h1>
52    <h2>Syntax</h2>
53    <div class="section">
54      <pre class="definition">class FileStream : public <a href="../../../nw/io/IOStream/Overview.html">nw::io::IOStream</a></pre>
55    </div>
56    <h2>Description</h2>
57    <div class="section">
58      <p>
59  </p>
60    </div>
61    <a name="typedef" id="typedef">
62      <h2><CODE>typedef</CODE> Definitions</h2>
63      <div class="section">
64        <table class="members">
65          <tr>
66            <td width="100" />
67            <th>
68              <a href="../../../nw/io/IOStream/IOStreamCallback.html">IOStreamCallback</a>
69            </th>
70            <td>This callback function is called after asynchronous processing completes.(Inherited from <a href="../../../nw/io/IOStream/Overview.html"><CODE>IOStream</CODE></a>.)</td>
71          </tr> </table>
72      </div>
73    </a> <a name="variable" id="variable">
74      <h2>Member Variables</h2>
75      <div class="section">
76        <table class="members">
77          <tr>
78            <td width="100"> </td>
79            <th>
80              <span class="argument"><CODE>NW_UT_RUNTIME_TYPEINFO</CODE></span>
81            </th>
82            <td width="100" />
83            <td>
84        </td>
85          </tr>
86          <tr>
87            <td width="100">
88              <span class="protected_style" title="protected">protected</span> </td>
89            <th>
90              <span class="argument">mAvailable</span>
91            </th>
92            <td width="100">bool</td>
93            <td>
94        (Inherited from <a href="../../../nw/io/IOStream/Overview.html"><CODE>IOStream</CODE></a>.)</td>
95          </tr>
96          <tr>
97            <td width="100">
98              <span class="protected_style" title="protected">protected</span> </td>
99            <th>
100              <span class="argument">mAsyncResult</span>
101            </th>
102            <td width="100"><span>s32</span></td>
103            <td>
104        (Inherited from <a href="../../../nw/io/IOStream/Overview.html"><CODE>IOStream</CODE></a>.)</td>
105          </tr>
106          <tr>
107            <td width="100">
108              <span class="protected_style" title="protected">protected</span> </td>
109            <th>
110              <span class="argument">mCallback</span>
111            </th>
112            <td width="100"><a href="../../../nw/io/IOStream/IOStreamCallback.html">IOStreamCallback</a></td>
113            <td>
114        (Inherited from <a href="../../../nw/io/IOStream/Overview.html"><CODE>IOStream</CODE></a>.)</td>
115          </tr>
116          <tr>
117            <td width="100">
118              <span class="protected_style" title="protected">protected</span> </td>
119            <th>
120              <span class="argument">mArg</span>
121            </th>
122            <td width="100">void *</td>
123            <td>
124        (Inherited from <a href="../../../nw/io/IOStream/Overview.html"><CODE>IOStream</CODE></a>.)</td>
125          </tr> </table>
126      </div>
127    </a> <a name="function" id="function">
128      <h2>Member Functions</h2>
129      <div class="section">
130        <table class="members">
131          <tr>
132            <th class="category" colspan="3">Gets the property information of the file stream.</th>
133          </tr>
134          <tr>
135            <td width="100"> <span class="virtual_style" title="pure-virtual">PV</span>
136            </td>
137            <th>
138              <a href="../../../nw/io/FileStream/CanRead.html">CanRead</a>
139            </th>
140            <td>Gets whether this stream can be read.</td>
141          </tr>
142          <tr>
143            <td width="100"> <span class="virtual_style" title="pure-virtual">PV</span>
144            </td>
145            <th>
146              <a href="../../../nw/io/FileStream/CanWrite.html">CanWrite</a>
147            </th>
148            <td>Gets whether this stream can be written.</td>
149          </tr>
150          <tr>
151            <td width="100"> <span class="virtual_style" title="pure-virtual">PV</span>
152            </td>
153            <th>
154              <a href="../../../nw/io/FileStream/CanAsync.html">CanAsync</a>
155            </th>
156            <td>Gets whether this stream can be processed asynchronously.</td>
157          </tr>
158          <tr>
159            <td width="100"> <span class="virtual_style" title="virtual">V</span>
160            </td>
161            <th>
162              <a href="../../../nw/io/FileStream/GetOffsetAlign.html">GetOffsetAlign</a>
163            </th>
164            <td>Gets the alignment required as an offset position from the file pointer used when reading/writing files.</td>
165          </tr>
166          <tr>
167            <td width="100"> <span class="virtual_style" title="virtual">V</span>
168            </td>
169            <th>
170              <a href="../../../nw/io/FileStream/GetSizeAlign.html">GetSizeAlign</a>
171            </th>
172            <td>Gets the alignment required as a size to be read/written once when reading/writing files.</td>
173          </tr>
174          <tr>
175            <td width="100"> <span class="virtual_style" title="virtual">V</span>
176            </td>
177            <th>
178              <a href="../../../nw/io/FileStream/GetBufferAlign.html">GetBufferAlign</a>
179            </th>
180            <td>This function gets the alignment required for a buffer address used for sending/receiving data when reading/writing.</td>
181          </tr>
182          <tr>
183            <th class="category" colspan="3">File Stream Operations</th>
184          </tr>
185          <tr>
186            <td width="100"> <span class="virtual_style" title="virtual">V</span>
187            </td>
188            <th>
189              <a href="../../../nw/io/FileStream/Read.html"><CODE>Read</CODE></a>
190            </th>
191            <td>Reads data from the stream (synchronous process).</td>
192          </tr>
193          <tr>
194            <td width="100"> <span class="virtual_style" title="virtual">V</span>
195            </td>
196            <th>
197              <a href="../../../nw/io/FileStream/ReadAsync.html">ReadAsync</a>
198            </th>
199            <td>Reads data from the stream (asynchronous process).</td>
200          </tr>
201          <tr>
202            <td width="100"> <span class="virtual_style" title="virtual">V</span>
203            </td>
204            <th>
205              <a href="../../../nw/io/FileStream/Write.html"><CODE>Write</CODE></a>
206            </th>
207            <td>Writes data to the stream (synchronous process).</td>
208          </tr>
209          <tr>
210            <td width="100"> <span class="virtual_style" title="virtual">V</span>
211            </td>
212            <th>
213              <a href="../../../nw/io/FileStream/WriteAsync.html">WriteAsync</a>
214            </th>
215            <td>Writes data to the stream (asynchronous process).</td>
216          </tr>
217          <tr>
218            <td width="100">  </td>
219            <th>
220              <a href="../../../nw/io/IOStream/WaitAsync.html">WaitAsync</a>
221            </th>
222            <td>Waits for the completion of asynchronous processing.(Inherited from <a href="../../../nw/io/IOStream/Overview.html"><CODE>IOStream</CODE></a>.)</td>
223          </tr>
224          <tr>
225            <td width="100"> <span class="virtual_style" title="virtual">V</span>
226            </td>
227            <th>
228              <a href="../../../nw/io/FileStream/IsBusy.html"><CODE>IsBusy</CODE></a>
229            </th>
230            <td>Checks whether asynchronous processing is currently executing.</td>
231          </tr>
232          <tr>
233            <th class="category" colspan="3">Closes the file/gets status</th>
234          </tr>
235          <tr>
236            <td width="100"> <span class="virtual_style" title="pure-virtual">PV</span>
237            </td>
238            <th>
239              <a href="../../../nw/io/FileStream/Close.html"><CODE>Close</CODE></a>
240            </th>
241            <td>Closes a stream.</td>
242          </tr>
243          <tr>
244            <td width="100">  </td>
245            <th>
246              <a href="../../../nw/io/IOStream/IsAvailable.html">IsAvailable</a>
247            </th>
248            <td>Gets a value indicating whether the stream is currently available.(Inherited from <a href="../../../nw/io/IOStream/Overview.html"><CODE>IOStream</CODE></a>.)</td>
249          </tr>
250          <tr>
251            <th class="category" colspan="3">Other</th>
252          </tr>
253          <tr>
254            <td width="100"> <span class="virtual_style" title="pure-virtual">PV</span>
255            </td>
256            <th>
257              <a href="../../../nw/io/FileStream/GetSize.html">GetSize</a>
258            </th>
259            <td>
260        </td>
261          </tr>
262          <tr>
263            <td width="100"> <span class="virtual_style" title="virtual">V</span>
264            </td>
265            <th>
266              <a href="../../../nw/io/FileStream/Seek.html"><CODE>Seek</CODE></a>
267            </th>
268            <td>
269        </td>
270          </tr>
271          <tr>
272            <td width="100"> <span class="virtual_style" title="virtual">V</span>
273            </td>
274            <th>
275              <a href="../../../nw/io/FileStream/Cancel.html"><CODE>Cancel</CODE></a>
276            </th>
277            <td>
278        </td>
279          </tr>
280          <tr>
281            <td width="100"> <span class="virtual_style" title="virtual">V</span>
282            </td>
283            <th>
284              <a href="../../../nw/io/FileStream/CancelAsync.html">CancelAsync</a>
285            </th>
286            <td>
287        </td>
288          </tr>
289          <tr>
290            <td width="100"> <span class="virtual_style" title="pure-virtual">PV</span>
291            </td>
292            <th>
293              <a href="../../../nw/io/FileStream/CanSeek.html">CanSeek</a>
294            </th>
295            <td>
296        </td>
297          </tr>
298          <tr>
299            <td width="100"> <span class="virtual_style" title="pure-virtual">PV</span>
300            </td>
301            <th>
302              <a href="../../../nw/io/FileStream/CanCancel.html">CanCancel</a>
303            </th>
304            <td>
305        </td>
306          </tr>
307          <tr>
308            <td width="100"> <span class="virtual_style" title="pure-virtual">PV</span>
309            </td>
310            <th>
311              <a href="../../../nw/io/FileStream/Tell.html">Tell</a>
312            </th>
313            <td>
314        </td>
315          </tr>
316          <tr>
317            <td width="100">  </td>
318            <th>
319              <a href="../../../nw/io/FileStream/IsEof.html">IsEof</a>
320            </th>
321            <td>
322        </td>
323          </tr>
324          <tr>
325            <td width="100">
326              <span class="protected_style" title="protected">protected</span>  </td>
327            <th>
328              <a href="../../../nw/io/FileStream/FileStream.html">FileStream</a>
329            </th>
330            <td>
331        </td>
332          </tr> </table>
333      </div>
334    </a>
335    <h2>Class Hierarchy</h2>
336    <div class="section">
337      <p class="hierarchy"><a href="../../../nw/io/IOStream/Overview.html">nw::io::IOStream</a><br />  <b>nw::io::FileStream</b>
338      </p>
339    </div>
340  <hr><p>CONFIDENTIAL</p></body>
341</html>
342