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>Unmount</title>
8  </head>
9  <body>
10<h1><CODE>nn::fs::Unmount</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../nn/Result/Overview.html">Result</a> Unmount(
15     const char * archiveName
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 archive name.</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>ResultNotFound</CODE></th>
50<td>The specified archive has not been mounted. You must not allow this error to occur in retail products.</td>
51        </tr>
52        <tr>
53<th>A value other than the above.</th>
54<td>An application bug or some other unexpected error.</td>
55        </tr>
56      </table> </div>
57<h2>Description</h2>
58    <div class="section">
59<p>Unmounts an archive.</p><p>Call this function to unmount a region when a mounted archive is no longer necessary.</p><p>If you have enabled automatic redundancy for save data, do not forget to call the <a href="../../nn/fs/CommitSaveData.html"><CODE>CommitSaveData</CODE></a> function before unmounting.</p><p>Before you unmount an archive, call <CODE>Finalize</CODE> on all files and directories that open from it. If you have written to a file without calling <CODE>Flush</CODE>, do not forget to call <CODE>Flush</CODE> when you close the file.</p><!-- write here --></div>
60<h2>Revision History</h2>
61    <div class="section">
62      <dl class="history">
63        <dt>2010/12/14</dt>
64<dd>Added return values.
65        </dd>
66        <dt>2010/12/10</dt>
67<dd>Added a note about <CODE>Finalize</CODE> for files and directories during unmount operations.
68        </dd>
69        <dt>2010/11/13</dt>
70<dd>Added cautions for unmounting.<br />
71        </dd>
72        <dt>2010/08/16</dt>
73<dd>Initial version.<br />
74        </dd>
75      </dl>
76    </div>
77  <hr><p>CONFIDENTIAL</p></body>
78</html>