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