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::IOStream</title> 49 </head> 50 <body> 51 <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/io/Overview.html">io</a>::IOStream</CODE> Class</h1> 52 <h2>Syntax</h2> 53 <div class="section"> 54 <pre class="definition">class IOStream</pre> 55 </div> 56 <h2>Description</h2> 57 <div class="section"> 58 <p>The file stream base class.</p><p>This is the base class for performing operations on data file streams. Implementation is carried out using derived classes.</p></div> 59 <a name="typedef" id="typedef"> 60 <h2><CODE>typedef</CODE> Definitions</h2> 61 <div class="section"> 62 <table class="members"> 63 <tr> 64 <td width="100" /> 65 <th> 66 <a href="../../../nw/io/IOStream/IOStreamCallback.html">IOStreamCallback</a> 67 </th> 68 <td>This callback function is called after asynchronous processing completes.</td> 69 </tr> </table> 70 </div> 71 </a> <a name="variable" id="variable"> 72 <h2>Member Variables</h2> 73 <div class="section"> 74 <table class="members"> 75 <tr> 76 <td width="100"> </td> 77 <th> 78 <span class="argument"><CODE>NW_UT_RUNTIME_TYPEINFO</CODE></span> 79 </th> 80 <td width="100" /> 81 <td> 82 </td> 83 </tr> 84 <tr> 85 <td width="100"> 86 <span class="protected_style" title="protected">protected</span> </td> 87 <th> 88 <span class="argument">mAvailable</span> 89 </th> 90 <td width="100">bool</td> 91 <td> 92 </td> 93 </tr> 94 <tr> 95 <td width="100"> 96 <span class="protected_style" title="protected">protected</span> </td> 97 <th> 98 <span class="argument">mAsyncResult</span> 99 </th> 100 <td width="100"><span>s32</span></td> 101 <td> 102 </td> 103 </tr> 104 <tr> 105 <td width="100"> 106 <span class="protected_style" title="protected">protected</span> </td> 107 <th> 108 <span class="argument">mCallback</span> 109 </th> 110 <td width="100"><a href="../../../nw/io/IOStream/IOStreamCallback.html">IOStreamCallback</a></td> 111 <td> 112 </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 width="100">void *</td> 121 <td> 122 </td> 123 </tr> </table> 124 </div> 125 </a> <a name="function" id="function"> 126 <h2>Member Functions</h2> 127 <div class="section"> 128 <table class="members"> 129 <tr> 130 <th class="category" colspan="3">Constructors/Destructors</th> 131 </tr> 132 <tr> 133 <td width="100"> <span class="virtual_style" title="virtual">V</span> 134 </td> 135 <th> 136 <a href="../../../nw/io/IOStream/~IOStream.html">~IOStream</a> 137 </th> 138 <td>Destructor.</td> 139 </tr> 140 <tr> 141 <td width="100"> 142 <span class="protected_style" title="protected">protected</span> </td> 143 <th> 144 <a href="../../../nw/io/IOStream/IOStream.html">IOStream</a> 145 </th> 146 <td>Constructor.</td> 147 </tr> 148 <tr> 149 <th class="category" colspan="3">Gets the property information of the file stream.</th> 150 </tr> 151 <tr> 152 <td width="100"> <span class="virtual_style" title="pure-virtual">PV</span> 153 </td> 154 <th> 155 <a href="../../../nw/io/IOStream/CanRead.html">CanRead</a> 156 </th> 157 <td>Gets whether this stream can be read.</td> 158 </tr> 159 <tr> 160 <td width="100"> <span class="virtual_style" title="pure-virtual">PV</span> 161 </td> 162 <th> 163 <a href="../../../nw/io/IOStream/CanWrite.html">CanWrite</a> 164 </th> 165 <td>Gets whether this stream can be written.</td> 166 </tr> 167 <tr> 168 <td width="100"> <span class="virtual_style" title="pure-virtual">PV</span> 169 </td> 170 <th> 171 <a href="../../../nw/io/IOStream/CanAsync.html">CanAsync</a> 172 </th> 173 <td>Gets whether this stream can be processed asynchronously.</td> 174 </tr> 175 <tr> 176 <td width="100"> <span class="virtual_style" title="virtual">V</span> 177 </td> 178 <th> 179 <a href="../../../nw/io/IOStream/GetOffsetAlign.html">GetOffsetAlign</a> 180 </th> 181 <td>Gets the alignment required as an offset position from the file pointer used when reading/writing files.</td> 182 </tr> 183 <tr> 184 <td width="100"> <span class="virtual_style" title="virtual">V</span> 185 </td> 186 <th> 187 <a href="../../../nw/io/IOStream/GetSizeAlign.html">GetSizeAlign</a> 188 </th> 189 <td>Gets the alignment required as a size to be read/written once when reading/writing files.</td> 190 </tr> 191 <tr> 192 <td width="100"> <span class="virtual_style" title="virtual">V</span> 193 </td> 194 <th> 195 <a href="../../../nw/io/IOStream/GetBufferAlign.html">GetBufferAlign</a> 196 </th> 197 <td>This function gets the alignment required for a buffer address used for sending/receiving data when reading/writing.</td> 198 </tr> 199 <tr> 200 <th class="category" colspan="3">File Stream Operations</th> 201 </tr> 202 <tr> 203 <td width="100"> <span class="virtual_style" title="virtual">V</span> 204 </td> 205 <th> 206 <a href="../../../nw/io/IOStream/Read.html"><CODE>Read</CODE></a> 207 </th> 208 <td>Reads data from the stream (synchronous process).</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/io/IOStream/ReadAsync.html">ReadAsync</a> 215 </th> 216 <td>Reads data from the stream (asynchronous 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/io/IOStream/Write.html"><CODE>Write</CODE></a> 223 </th> 224 <td>Writes data to the stream (synchronous process).</td> 225 </tr> 226 <tr> 227 <td width="100"> <span class="virtual_style" title="virtual">V</span> 228 </td> 229 <th> 230 <a href="../../../nw/io/IOStream/WriteAsync.html">WriteAsync</a> 231 </th> 232 <td>Writes data to the stream (asynchronous process).</td> 233 </tr> 234 <tr> 235 <td width="100"> </td> 236 <th> 237 <a href="../../../nw/io/IOStream/WaitAsync.html">WaitAsync</a> 238 </th> 239 <td>Waits for the completion of asynchronous processing.</td> 240 </tr> 241 <tr> 242 <td width="100"> <span class="virtual_style" title="virtual">V</span> 243 </td> 244 <th> 245 <a href="../../../nw/io/IOStream/IsBusy.html"><CODE>IsBusy</CODE></a> 246 </th> 247 <td>Checks whether asynchronous processing is currently executing.</td> 248 </tr> 249 <tr> 250 <th class="category" colspan="3">Closes the file/gets status</th> 251 </tr> 252 <tr> 253 <td width="100"> <span class="virtual_style" title="pure-virtual">PV</span> 254 </td> 255 <th> 256 <a href="../../../nw/io/IOStream/Close.html"><CODE>Close</CODE></a> 257 </th> 258 <td>Closes a stream.</td> 259 </tr> 260 <tr> 261 <td width="100"> </td> 262 <th> 263 <a href="../../../nw/io/IOStream/IsAvailable.html">IsAvailable</a> 264 </th> 265 <td>Gets a value indicating whether the stream is currently available.</td> 266 </tr> </table> 267 </div> 268 </a> 269 <h2>Revision History</h2> 270 <div class="section"> 271 <dl class="history"> 272 <dt>2009/10/20</dt> 273 <dd>Initial version.<br /> 274 </dd> 275 </dl> 276 </div> 277 <hr><p>CONFIDENTIAL</p></body> 278</html> 279