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>MountSaveData</title>
8  </head>
9  <body>
10<h1><CODE>nn::fs::MountSaveData</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../nn/Result/Overview.html">Result</a> MountSaveData(
15     const char * archiveName = &quot;data:&quot;
16);
17</pre>
18    </div>
19<h2>Arguments</h2>
20    <div class="section">
21      <table class="arguments">
22        <thead>
23          <tr>
24            <td width="15" />
25<th>Name</th>
26<td>Description</td>
27          </tr>
28        </thead>
29        <tr>
30<td>in</td>
31<th>archiveName</th>
32<td>Specifies the name of the archive. (If this argument is omitted, &quot;<CODE>data:</CODE>&quot; is specified.)</td>
33        </tr> </table>
34    </div>
35<h2>Return Values</h2>
36<div class="section">Returns the result of the operation. <br />
37      <table class="arguments">
38        <thead>
39          <tr>
40<th>Value</th>
41<td>Description</td>
42          </tr>
43        </thead>
44        <tr>
45<th>Success.</th>
46<td>Process was successful. The return value's <CODE>IsSuccess</CODE> function returns <CODE>true</CODE> in this state.</td>
47        </tr>
48        <tr>
49<th><CODE>ResultAlreadyExists</CODE></th>
50<td>The specified archive name is already mounted. <BR>You must not allow this error to occur in retail products.</td>
51        </tr>
52        <tr>
53<th><CODE>ResultOperationDenied</CODE></th>
54<td>Operation denied because save data is currently mounting.<br /> You must not allow this error to occur in retail products.</td>
55        </tr>
56        <tr>
57<th><CODE>ResultNotFormatted</CODE></th>
58<td>Data region not formatted. Format it by calling the <a href="../../nn/fs/FormatSaveData.html"><CODE>FormatSaveData</CODE></a> function.</td>
59        </tr>
60        <tr>
61<th><CODE>ResultBadFormat</CODE></th>
62<td>Data region format invalid. Format it by calling the <a href="../../nn/fs/FormatSaveData.html"><CODE>FormatSaveData</CODE></a> function.</td>
63        </tr>
64        <tr>
65<th><CODE>ResultVerificationFailed</CODE></th>
66<td>Either verification failed or some form of tampering was detected. Format it by calling the <a href="../../nn/fs/FormatSaveData.html"><CODE>FormatSaveData</CODE></a> function.</td>
67        </tr>
68        <tr>
69<th>A value other than the above.</th>
70<td>An application bug or some other unexpected error.</td>
71        </tr>
72      </table> </div>
73<h2>Description</h2>
74    <div class="section">
75<p>Mounts a save data archive.</p><p>Mounts an application-specific save data region and gives it the specified archive name. The save data region must be formatted before it can be used.</p><p>Be sure to check the return value when you call this function to determine whether the save data region is invalid. If the save data region is invalid, call the <a href="../../nn/fs/FormatSaveData.html"><CODE>FormatSaveData</CODE></a> function to initialize it. Call this function again afterwards to mount it.</p><p>
76The following page has hints on how to handle mount errors. Please use this as a reference.
77</p><ul><li><a href="briefing/aboutErrorHandling.html#Mounting_SaveDataArchive">Error handling when mounting: save data archive</a></li></ul><h3>Double Mounting</h3><div class="section">
78When save data are mounted a second time, the correct behavior is for there to be an error and for the function to return <CODE><a href="../../nn/fs/ResultOperationDenied/Overview.html">nn::fs::ResultOperationDenied</a></CODE>. However, because of a bug, different versions of the CTR-SDK will return different results.
79
80<p><table><thead><th>SDK version</th><th>Return Values</th></thead><tr><td>Version 1.2 or earlier</td><td>Returns <I>success</I>.</td></tr><tr><td>Versions 1.3 to 1.X</td><td>Returns <CODE><a href="../../nn/fs/ResultOperationDenied/Overview.html">nn::fs::ResultOperationDenied</a></CODE>.</td></tr><tr><td>Versions 2.0 to 2.2</td><td>Returns <CODE><a href="../../nn/fs/ResultAccessDenied/Overview.html">nn::fs::ResultAccessDenied</a></CODE>.</td></tr><tr><td>Version 2.3 or later</td><td>Returns <CODE><a href="../../nn/fs/ResultOperationDenied/Overview.html">nn::fs::ResultOperationDenied</a></CODE>.</td></tr></table></p>
81
82In CTR-SDK versions 1.2 and earlier, <I>success </I>is returned, however, double mounting is not supported. Do not mount twice because there is a risk of corrupting the save data when writing and performing other operations.
83                </div></div>
84<h2>Revision History</h2>
85    <div class="section">
86      <dl class="history">
87        <dt>2011/04/15</dt>
88<dd>Added the section <B>Double Mounting</B>.<br />
89        </dd>
90        <dt>2011/04/13</dt>
91<dd>Added the return value <CODE>ResultOperationDenied</CODE>.<br />
92        </dd>
93        <dt>2010/12/15</dt>
94<dd>Added a link to the error handling page.
95        </dd>
96        <dt>2010/08/16</dt>
97<dd>Initial version.<br />
98        </dd>
99      </dl>
100    </div>
101  <hr><p>CONFIDENTIAL</p></body>
102</html>