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>FormatSaveData</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../nn/Overview.html">nn</a>::<a href="../../nn/fs/Overview.html">fs</a>::FormatSaveData</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../nn/Result/Overview.html">Result</a> FormatSaveData(
15     size_t maxFiles,
16     size_t maxDirectories,
17     bool isDuplicateAll = false
18);
19</pre>
20    </div>
21<h2>Parameters</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>maxFiles</th>
34<td>Specifies the maximum number of files.</td>
35        </tr>
36        <tr>
37<td>in</td>
38<th>maxDirectories</th>
39<td>Specifies the maximum number of directories.</td>
40        </tr>
41        <tr>
42<td>in</td>
43<th>isDuplicateAll</th>
44<td>Specifies whether to duplicate the entire save data region.</td>
45        </tr> </table>
46    </div>
47<h2>Return Values</h2>
48<div class="section">Returns the result of the operation. <br />
49      <table class="arguments">
50        <thead>
51          <tr>
52<th>Value</th>
53<td>Description</td>
54          </tr>
55        </thead>
56        <tr>
57<th><CODE>Result::IsSuccess</CODE></th>
58<td>Process was successful.</td>
59        </tr>
60        <tr>
61<th><CODE>ResultNotEnoughSpace</CODE></th>
62<td>The values of <CODE>maxFiles</CODE> and <CODE>maxDirectories</CODE> are too large for save data. You must not allow this error to occur in retail products.</td>
63        </tr>
64        <tr>
65<th>A value other than the above.</th>
66<td>An unexpected or fatal error occurred.</td>
67        </tr>
68      </table> </div>
69<h2>Description</h2>
70    <div class="section">
71<p>Formats a save data region.</p><p>Formats an application-specific save data region. Calling this function will erase any save data that may have existed there.</p><p>When you format this save data region, you can specify the maximum number of files and directories that it can hold. Note that you cannot create any more than this number of files and directories.</p><p>When formatting with <CODE>isDuplicateAll</CODE> set to <CODE>true</CODE>, be sure to call the <a href="../../nn/fs/CommitSaveData.html"><CODE>CommitSaveData</CODE></a> function before unmounting the save data.</p><h3>Note</h3><div class="section">
72When mounting save data, always be sure to unmount before formatting. Otherwise, the <a href="../../nn/fs/MountSaveData.html"><CODE>nn::fs::MountSaveData</CODE></a> function will return success, but operations on the mounted archive are not guaranteed.
73</div><h3> About SaveDataSize</h3><div class="section">If the value specified for <SPAN class="argument">SaveDataSize</SPAN> in the <CODE><a href="../../../tools/ctr_makerom.html#rsf">RSF</a></CODE> file differs from the actual size of the backup memory, then the backup memory size takes precedence. Even when 128 KB is specified for <SPAN class="argument">SaveDataSize</SPAN>, if 512 KB of backup memory is being used, then it formats with a size of 512 KB. Formatting is still possible even if 0 KB is specified.<br />If you use a different backup memory size in development than in your product, manage available space with care.<br /><br />If the value specified in <SPAN class="argument">SaveDataSize</SPAN> differs from the size of the backup memory used in the product, it causes an error in checking when the master ROM is submitted.
74            </div></div>
75<h2>Revision History</h2>
76    <div class="section">
77      <dl class="history">
78        <dt>2012/01/20</dt>
79<dd>Changed the parameter specified in the RSF file to SaveDataSize instead of BackupMemoryType.<br />
80        </dd>
81        <dt>2011/03/25</dt>
82<dd>Added cautions about <CODE>BackupMemoryType</CODE>.<br />
83        </dd>
84        <dt>2011/02/07</dt>
85<dd>Included a note about formatting when mounted.<br />
86        </dd>
87        <dt>2010/12/14</dt>
88<dd>Added return values.
89        </dd>
90        <dt>2010/08/16</dt>
91<dd>Initial version.<br />
92        </dd>
93      </dl>
94    </div>
95  <hr><p>CONFIDENTIAL</p></body>
96</html>