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<title>Write</title>
8  </head>
9  <body>
10<h1><CODE>nn::fs::FileOutputStream::Write</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14virtual s32 Write(
15     const void * buffer,
16     size_t size,
17     bool flush = true
18);
19</pre>
20    </div>
21<h2>Arguments</h2>
22    <div class="section">
23      <table class="arguments">
24        <thead>
25          <tr>
26            <td width="15" />
27<th>Name</th>
28<td>Description</td>
29          </tr>
30        </thead>
31        <tr>
32<td>in</td>
33<th>buffer</th>
34<td>Pointer to the buffer that contains the data to write.</td>
35        </tr>
36        <tr>
37<td>in</td>
38<th>size</th>
39<td>Maximum number of bytes to write to the file.</td>
40        </tr>
41        <tr>
42<td>in</td>
43<th>flush</th>
44<td>Specifies whether to write back to the device.</td>
45        </tr> </table>
46    </div>
47<h2>Return Values</h2>
48<div class="section">Returns the actual number of bytes that were written. </div>
49<h2>Description</h2>
50    <div class="section">
51<p>Writes the specified amount of data from a buffer to a file.</p><p>Up to <SPAN class="argument">size</SPAN> bytes of data are written to the file from the region at the address specified by <SPAN class="argument">buffer</SPAN>.</p><p>If you have specified a value of <CODE>false</CODE> for the <SPAN class="argument">flush</SPAN> argument, do not call the <a href="../../../nn/fs/FileOutputStream/Finalize.html"><CODE>Finalize</CODE></a> function until you have either called <a href="../../../nn/fs/FileOutputStream/TryFlush.html"><CODE>TryFlush</CODE></a> or called this function with <SPAN class="argument">flush</SPAN> set equal to <CODE>true</CODE>.</p><p>
52This function is implemented to show an error screen when errors occur internally, whether or not such errors are fatal. Control does not return from the function in this case. Use <CODE><a href="../../../nn/fs/FileOutputStream/TryWrite.html">nn::fs::FileOutputStream::TryWrite</a></CODE> on everything other than ROM archives.
53            </p><p>
54To read details about error handling, see <a href="../briefing/aboutErrorHandling.html#FileAndDirectory">Handling Errors During File and Directory Operations</a>.
55            </p></div>
56<h2>Revision History</h2>
57    <div class="section">
58      <dl class="history">
59        <dt>2010/12/24</dt>
60<dd>Added a link to the error handling page.
61        </dd>
62        <dt>2010/10/05</dt>
63<dd>Corrected the text.<br />
64        </dd>
65        <dt>2010/01/29</dt>
66<dd>Initial version.<br />
67        </dd>
68      </dl>
69    </div>
70  <hr><p>CONFIDENTIAL</p></body>
71</html>