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::HioFileStream</title> 49 </head> 50 <body> 51 <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/io/Overview.html">io</a>::HioFileStream</CODE> Class</h1> 52 <h2>Syntax</h2> 53 <div class="section"> 54 <pre class="definition">class HioFileStream : public <a href="../../../nw/io/FileStream/Overview.html">nw::io::FileStream</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="virtual">V</span> 136 </td> 137 <th> 138 <a href="../../../nw/io/HioFileStream/GetOffsetAlign.html">GetOffsetAlign</a> 139 </th> 140 <td>Gets the alignment required as an offset position from the file pointer used when reading/writing files.</td> 141 </tr> 142 <tr> 143 <td width="100"> <span class="virtual_style" title="virtual">V</span> 144 </td> 145 <th> 146 <a href="../../../nw/io/HioFileStream/GetSizeAlign.html">GetSizeAlign</a> 147 </th> 148 <td>Gets the alignment required as a size to be read/written once when reading/writing files.</td> 149 </tr> 150 <tr> 151 <td width="100"> <span class="virtual_style" title="virtual">V</span> 152 </td> 153 <th> 154 <a href="../../../nw/io/HioFileStream/GetBufferAlign.html">GetBufferAlign</a> 155 </th> 156 <td>This function gets the alignment required for a buffer address used for sending/receiving data when reading/writing.</td> 157 </tr> 158 <tr> 159 <th class="category" colspan="3">File Stream Operations</th> 160 </tr> 161 <tr> 162 <td width="100"> <span class="virtual_style" title="virtual">V</span> 163 </td> 164 <th> 165 <a href="../../../nw/io/HioFileStream/ReadAsync.html">ReadAsync</a> 166 </th> 167 <td>Reads data from the stream (asynchronous process).</td> 168 </tr> 169 <tr> 170 <td width="100"> <span class="virtual_style" title="virtual">V</span> 171 </td> 172 <th> 173 <a href="../../../nw/io/HioFileStream/WriteAsync.html">WriteAsync</a> 174 </th> 175 <td>Writes data to the stream (asynchronous process).</td> 176 </tr> 177 <tr> 178 <td width="100"> </td> 179 <th> 180 <a href="../../../nw/io/IOStream/WaitAsync.html">WaitAsync</a> 181 </th> 182 <td>Waits for the completion of asynchronous processing.(Inherited from <a href="../../../nw/io/IOStream/Overview.html"><CODE>IOStream</CODE></a>.)</td> 183 </tr> 184 <tr> 185 <td width="100"> <span class="virtual_style" title="virtual">V</span> 186 </td> 187 <th> 188 <a href="../../../nw/io/HioFileStream/IsBusy.html"><CODE>IsBusy</CODE></a> 189 </th> 190 <td>Checks whether asynchronous processing is currently executing.</td> 191 </tr> 192 <tr> 193 <th class="category" colspan="3">Closes the file/gets status</th> 194 </tr> 195 <tr> 196 <td width="100"> </td> 197 <th> 198 <a href="../../../nw/io/IOStream/IsAvailable.html">IsAvailable</a> 199 </th> 200 <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> 201 </tr> 202 <tr> 203 <th class="category" colspan="3">Other</th> 204 </tr> 205 <tr> 206 <td width="100"> </td> 207 <th> 208 <a href="../../../nw/io/HioFileStream/HioFileStream.html">HioFileStream</a> 209 </th> 210 <td> 211 </td> 212 </tr> 213 <tr> 214 <td width="100"> <span class="virtual_style" title="virtual">V</span> 215 </td> 216 <th> 217 <a href="../../../nw/io/HioFileStream/~HioFileStream.html">~HioFileStream</a> 218 </th> 219 <td> 220 </td> 221 </tr> 222 <tr> 223 <td width="100"> </td> 224 <th> 225 <a href="../../../nw/io/HioFileStream/Open.html"><CODE>Open</CODE></a> 226 </th> 227 <td> 228 </td> 229 </tr> 230 <tr> 231 <td width="100"> <span class="virtual_style" title="virtual">V</span> 232 </td> 233 <th> 234 <a href="../../../nw/io/HioFileStream/Close.html"><CODE>Close</CODE></a> 235 </th> 236 <td>Closes a stream.</td> 237 </tr> 238 <tr> 239 <td width="100"> <span class="virtual_style" title="virtual">V</span> 240 </td> 241 <th> 242 <a href="../../../nw/io/HioFileStream/Read.html"><CODE>Read</CODE></a> 243 </th> 244 <td>Reads data from the stream (synchronous process).</td> 245 </tr> 246 <tr> 247 <td width="100"> <span class="virtual_style" title="virtual">V</span> 248 </td> 249 <th> 250 <a href="../../../nw/io/HioFileStream/Write.html"><CODE>Write</CODE></a> 251 </th> 252 <td>Writes data to the stream (synchronous process).</td> 253 </tr> 254 <tr> 255 <td width="100"> <span class="virtual_style" title="virtual">V</span> 256 </td> 257 <th> 258 <a href="../../../nw/io/HioFileStream/Seek.html"><CODE>Seek</CODE></a> 259 </th> 260 <td> 261 </td> 262 </tr> 263 <tr> 264 <td width="100"> <span class="virtual_style" title="virtual">V</span> 265 </td> 266 <th> 267 <a href="../../../nw/io/HioFileStream/GetSize.html">GetSize</a> 268 </th> 269 <td> 270 </td> 271 </tr> 272 <tr> 273 <td width="100"> <span class="virtual_style" title="virtual">V</span> 274 </td> 275 <th> 276 <a href="../../../nw/io/HioFileStream/Tell.html">Tell</a> 277 </th> 278 <td> 279 </td> 280 </tr> 281 <tr> 282 <td width="100"> <span class="virtual_style" title="virtual">V</span> 283 </td> 284 <th> 285 <a href="../../../nw/io/HioFileStream/CanSeek.html">CanSeek</a> 286 </th> 287 <td> 288 </td> 289 </tr> 290 <tr> 291 <td width="100"> <span class="virtual_style" title="virtual">V</span> 292 </td> 293 <th> 294 <a href="../../../nw/io/HioFileStream/CanCancel.html">CanCancel</a> 295 </th> 296 <td> 297 </td> 298 </tr> 299 <tr> 300 <td width="100"> <span class="virtual_style" title="virtual">V</span> 301 </td> 302 <th> 303 <a href="../../../nw/io/HioFileStream/CanRead.html">CanRead</a> 304 </th> 305 <td>Gets whether this stream can be read.</td> 306 </tr> 307 <tr> 308 <td width="100"> <span class="virtual_style" title="virtual">V</span> 309 </td> 310 <th> 311 <a href="../../../nw/io/HioFileStream/CanWrite.html">CanWrite</a> 312 </th> 313 <td>Gets whether this stream can be written.</td> 314 </tr> 315 <tr> 316 <td width="100"> <span class="virtual_style" title="virtual">V</span> 317 </td> 318 <th> 319 <a href="../../../nw/io/HioFileStream/CanAsync.html">CanAsync</a> 320 </th> 321 <td>Gets whether this stream can be processed asynchronously.</td> 322 </tr> 323 <tr> 324 <td width="100"> <span class="virtual_style" title="virtual">V</span> 325 </td> 326 <th> 327 <a href="../../../nw/io/HioFileStream/Cancel.html"><CODE>Cancel</CODE></a> 328 </th> 329 <td> 330 </td> 331 </tr> 332 <tr> 333 <td width="100"> <span class="virtual_style" title="virtual">V</span> 334 </td> 335 <th> 336 <a href="../../../nw/io/HioFileStream/CancelAsync.html">CancelAsync</a> 337 </th> 338 <td> 339 </td> 340 </tr> 341 <tr> 342 <td width="100"> </td> 343 <th> 344 <a href="../../../nw/io/FileStream/IsEof.html">IsEof</a> 345 </th> 346 <td> 347 (Inherited from <a href="../../../nw/io/FileStream/Overview.html"><CODE>FileStream</CODE></a>.)</td> 348 </tr> </table> 349 </div> 350 </a> 351 <h2>Class Hierarchy</h2> 352 <div class="section"> 353 <p class="hierarchy"><a href="../../../nw/io/IOStream/Overview.html">nw::io::IOStream</a><br /> <a href="../../../nw/io/FileStream/Overview.html">nw::io::FileStream</a><br /> <b>nw::io::HioFileStream</b> 354 </p> 355 </div> 356 <hr><p>CONFIDENTIAL</p></body> 357</html> 358