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>nn::fs::FileStream</title> 51 </head> 52 <body> 53<h1><CODE>nn::fs::FileStream</CODE> Class</h1> 54<h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class FileStream : <br /> private nn::fs::IStream,<br /> private nn::fs::detail::FileBase,<br /> private ADLFireWall::NonCopyable<FileStream></pre> 57 </div> 58<h2>Description</h2> 59 <div class="section"> 60<p>Class for reading from and writing to files.</p><p>Can open the file specified by a path name and read and write data from and to it.</p><p>Although it is possible to use either wide-character strings or multibyte-character strings to specify the path name, use wide-character strings unless you have a special reason to do otherwise.</p><p>This class cannot be used to create new files in expanded save data. For that, use a <a href="../../../nn/fs/TryCreateFile.html"><CODE>TryCreateFile</CODE></A> function that specifies the size.</p><!-- write here --></div> 61 <a name="function" id="function"> 62<h2>Member Functions</h2> 63 <div class="section"> 64 <table class="members"> 65 <tr> 66 <td width="100"> </td> 67 <th> 68<a href="../../../nn/fs/FileStream/FileStream.html"><CODE>FileStream</CODE></a> 69 </th> 70<td>Constructor.</td> 71 </tr> 72 <tr> 73 <td width="100"> </td> 74 <th> 75<a href="../../../nn/fs/FileStream/Initialize.html"><CODE>Initialize</CODE></a> 76 </th> 77<td>Opens the specified file.</td> 78 </tr> 79 <tr> 80 <td width="100"> </td> 81 <th> 82<a href="../../../nn/fs/FileStream/TryInitialize.html"><CODE>TryInitialize</CODE></a> 83 </th> 84<td>Opens the specified file.</td> 85 </tr> 86 <tr> 87 <td width="100"> </td> 88 <th> 89<a href="../../../nn/fs/FileStream/Finalize.html"><CODE>Finalize</CODE></a> 90 </th> 91<td>Closes a file.</td> 92 </tr> 93 <tr> 94<td width="100"> <span class="virtual_style" title="virtual">V</span> 95 </td> 96 <th> 97<a href="../../../nn/fs/FileStream/~FileStream.html"><CODE>~FileStream</CODE></a> 98 </th> 99<td>Destructor.</td> 100 </tr> 101 <tr> 102<td width="100"> <span class="virtual_style" title="virtual">V</span> 103 </td> 104 <th> 105<a href="../../../nn/fs/FileStream/Read.html"><CODE>Read</CODE></a> 106 </th> 107<td>Loads the specified amount of data from a file into a buffer.</td> 108 </tr> 109 <tr> 110<td width="100"> <span class="virtual_style" title="virtual">V</span> 111 </td> 112 <th> 113<a href="../../../nn/fs/FileStream/TryRead.html"><CODE>TryRead</CODE></a> 114 </th> 115<td>Loads the specified amount of data from a file into a buffer.</td> 116 </tr> 117 <tr> 118<td width="100"> <span class="virtual_style" title="virtual">V</span> 119 </td> 120 <th> 121<a href="../../../nn/fs/FileStream/Write.html"><CODE>Write</CODE></a> 122 </th> 123<td>Writes the specified amount of data from a buffer to a file.</td> 124 </tr> 125 <tr> 126<td width="100"> <span class="virtual_style" title="virtual">V</span> 127 </td> 128 <th> 129<a href="../../../nn/fs/FileStream/TryWrite.html"><CODE>TryWrite</CODE></a> 130 </th> 131<td>Writes the specified amount of data from a buffer to a file.</td> 132 </tr> 133 <tr> 134<td width="100"> <span class="virtual_style" title="virtual">V</span> 135 </td> 136 <th> 137<a href="../../../nn/fs/FileStream/Seek.html"><CODE>Seek</CODE></a> 138 </th> 139<td>Changes the read/write position in a file.</td> 140 </tr> 141 <tr> 142<td width="100"> <span class="virtual_style" title="virtual">V</span> 143 </td> 144 <th> 145<a href="../../../nn/fs/FileStream/TrySeek.html"><CODE>TrySeek</CODE></a> 146 </th> 147<td>Changes the read position of a file.</td> 148 </tr> 149 <tr> 150<td width="100"> <span class="virtual_style" title="virtual">V</span> 151 </td> 152 <th> 153<a href="../../../nn/fs/FileStream/GetPosition.html"><CODE>GetPosition</CODE></a> 154 </th> 155<td>Gets the current read position relative to the start of the file.</td> 156 </tr> 157 <tr> 158<td width="100"> <span class="virtual_style" title="virtual">V</span> 159 </td> 160 <th> 161<a href="../../../nn/fs/FileStream/TryGetPosition.html"><CODE>TryGetPosition</CODE></a> 162 </th> 163<td>Gets the current read position relative to the start of the file.</td> 164 </tr> 165 <tr> 166<td width="100"> <span class="virtual_style" title="virtual">V</span> 167 </td> 168 <th> 169<a href="../../../nn/fs/FileStream/SetPosition.html"><CODE>SetPosition</CODE></a> 170 </th> 171<td>Sets the current read position relative to the start of the file.</td> 172 </tr> 173 <tr> 174<td width="100"> <span class="virtual_style" title="virtual">V</span> 175 </td> 176 <th> 177<a href="../../../nn/fs/FileStream/TrySetPosition.html"><CODE>TrySetPosition</CODE></a> 178 </th> 179<td>Sets the current read position relative to the start of the file.</td> 180 </tr> 181 <tr> 182<td width="100"> <span class="virtual_style" title="virtual">V</span> 183 </td> 184 <th> 185<a href="../../../nn/fs/FileStream/GetSize.html"><CODE>GetSize</CODE></a> 186 </th> 187<td>Gets the file size.</td> 188 </tr> 189 <tr> 190<td width="100"> <span class="virtual_style" title="virtual">V</span> 191 </td> 192 <th> 193<a href="../../../nn/fs/FileStream/TryGetSize.html"><CODE>TryGetSize</CODE></a> 194 </th> 195<td>Gets the file size.</td> 196 </tr> 197 <tr> 198<td width="100"> <span class="virtual_style" title="virtual">V</span> 199 </td> 200 <th> 201<a href="../../../nn/fs/FileStream/SetSize.html"><CODE>SetSize</CODE></a> 202 </th> 203<td>Sets the file size.</td> 204 </tr> 205 <tr> 206<td width="100"> <span class="virtual_style" title="virtual">V</span> 207 </td> 208 <th> 209<a href="../../../nn/fs/FileStream/TrySetSize.html"><CODE>TrySetSize</CODE></a> 210 </th> 211<td>Sets the file size.</td> 212 </tr> 213 <tr> 214<td width="100"> <span class="virtual_style" title="virtual">V</span> 215 </td> 216 <th> 217<a href="../../../nn/fs/FileStream/Flush.html"><CODE>Flush</CODE></a> 218 </th> 219<td>Writes the file cache back to the device.</td> 220 </tr> 221 <tr> 222<td width="100"> <span class="virtual_style" title="virtual">V</span> 223 </td> 224 <th> 225<a href="../../../nn/fs/FileStream/TryFlush.html"><CODE>TryFlush</CODE></a> 226 </th> 227<td>Writes the file cache back to the device.</td> 228 </tr> </table> 229 </div> 230 </a> 231<h2>Class Hierarchy</h2> 232 <div class="section"> 233<p class="hierarchy"><span>nn::fs::IPositionable</span><br /> <span>nn::fs::IInputStream</span><br /> <span>nn::fs::IStream</span><br /> <b>nn::fs::FileStream</b> 234 </p> 235 </div> 236<h2>Revision History</h2> 237 <div class="section"> 238 <dl class="history"> 239 <dt>2010/01/29</dt> 240<dd>Initial version.<br /> 241 </dd> 242 </dl> 243 </div> 244 <hr><p>CONFIDENTIAL</p></body> 245</html>