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><a href="../../nn/Overview.html">nn</a>::<a href="../../nn/fs/Overview.html">fs</a>::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,
16     <a href="../../nn_types/bit32.html">bit32</a> uniqueId
17);
18</pre>
19    </div>
20<h2>Parameters</h2>
21    <div class="section">
22      <table class="arguments">
23        <thead>
24          <tr>
25            <td width="15" />
26<th>Name</th>
27<td>Description</td>
28          </tr>
29        </thead>
30        <tr>
31<td>in</td>
32<th><CODE>archiveName</CODE></th>
33<td>Specifies the archive name.</td>
34        </tr>
35        <tr>
36<td>in</td>
37<th><CODE>uniqueId</CODE></th>
38<td>Specifies the unique ID for the other application.</td>
39        </tr> </table>
40    </div>
41<h2>Return Values</h2>
42<div class="section">Returns the result of the operation. <br />
43      <table class="arguments">
44        <thead>
45          <tr>
46<th>Value</th>
47<td>Description</td>
48          </tr>
49        </thead>
50        <tr>
51<th><CODE>Result::IsSuccess</CODE></th>
52<td>Process was successful.</td>
53        </tr>
54        <tr>
55<th><CODE>ResultAlreadyExists</CODE></th>
56<td>The specified archive name is already mounted. <BR>You must not allow this error to occur in retail products.</td>
57        </tr>
58        <tr>
59<th><CODE>ResultOperationDenied</CODE></th>
60<td>Operation denied because the save data are currently being mounted.<br /> You must not allow this error to occur in retail products.</td>
61        </tr>
62        <tr>
63<th><CODE>ResultNotFormatted</CODE></th>
64<td>Not formatted. The other application's format is prohibited, so that application itself needs to do the formatting.</td>
65        </tr>
66        <tr>
67<th><CODE>ResultBadFormat</CODE></th>
68<td>Invalid format. The other application's format is prohibited, so that application itself needs to do the formatting.</td>
69        </tr>
70        <tr>
71<th><CODE>ResultVerificationFailed</CODE></th>
72<td>Either verification failed or some form of tampering was detected. The other application's format is prohibited, so that application itself needs to do the formatting.</td>
73        </tr>
74        <tr>
75<th>A value other than the above</th>
76<td>An application bug or some other unexpected error.</td>
77        </tr>
78      </table> </div>
79<h2>Description</h2>
80    <div class="section">
81<p>Mounts the save data archive that is in another application.</p><p>The save data region of another application is mounted as a save data archive. The other application is specified by specifying its unique ID.</p><p>There is no ironclad guarantee that the save data this function is supposed to mount actually exists. For this reason, you need to prepare adequate error handling.</p><p>There are restrictions on the unique IDs that this function can specify, so for proper access you need to make the necessary descriptions in the RSF files of the programs that call this function. For details, see the <CODE><ulink url="../../../../tools/ctr_makerom.html#rsf">ctr_makerom</ulink></CODE> reference.</p><p>
82The following page has hints on how to handle mount errors. Please use this as a reference.
83</p><ul><li><a href="briefing/aboutErrorHandling.html#Mounting_SaveDataArchive">Handling Mount Errors: Save Data Archives</a></li></ul></div>
84<h2>Revision History</h2>
85    <div class="section">
86      <dl class="history">
87        <dt>2012/04/26</dt>
88<dd>Separated the demo-version functions.<br />
89        </dd>
90        <dt>2012/02/16</dt>
91<dd>Deleted text about double mounting.<br />Added overloaded version for mounting save data from other applications.<br />
92        </dd>
93        <dt>2011/04/15</dt>
94<dd>Added text about double mounting.<br />
95        </dd>
96        <dt>2011/04/13</dt>
97<dd>Added <B>ResultOperationDenied</B> to the Return Values.
98        </dd>
99        <dt>2010/12/15</dt>
100<dd>Added a link to the error handling page.
101        </dd>
102        <dt>2010/08/16</dt>
103<dd>Initial version.<br />
104        </dd>
105      </dl>
106    </div>
107  <hr><p>CONFIDENTIAL</p></body>
108</html>