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