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>nn::fs::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>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>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>Success.</th>
58<td>Process was successful. The return value's <CODE>IsSuccess</CODE> function returns <CODE>true</CODE> in this state.</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 true, be sure to call the <a href="../../nn/fs/CommitSaveData.html"><CODE>CommitSaveData</CODE></a> function before unmounting the save data.</p><!-- write here --></div>
72<h2>Revision History</h2>
73    <div class="section">
74      <dl class="history">
75        <dt>2010/12/14</dt>
76<dd>Added return values.
77        </dd>
78        <dt>2010/08/16</dt>
79<dd>Initial version.<br />
80        </dd>
81      </dl>
82    </div>
83  <hr><p>CONFIDENTIAL</p></body>
84</html>