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>MountRom</title>
8  </head>
9  <body>
10<h1><CODE>nn::fs::MountRom</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../nn/Result/Overview.html">Result</a> MountRom(
15     const char * archiveName,
16     size_t maxFile,
17     size_t maxDirectory,
18     void * workingMemory,
19     size_t workingMemorySize,
20     bool useCache = true
21);
22</pre>
23    </div>
24<h2>Arguments</h2>
25    <div class="section">
26      <table class="arguments">
27        <thead>
28          <tr>
29            <td width="15" />
30<th>Name</th>
31<td>Description</td>
32          </tr>
33        </thead>
34        <tr>
35<td>in</td>
36<th>archiveName</th>
37<td>Specifies the name of the archive. (In the overloaded version of this function in which this argument is omitted, &quot;<CODE>rom:</CODE>&quot; is specified implicitly.)</td>
38        </tr>
39        <tr>
40<td>in</td>
41<th>maxFile</th>
42<td>The maximum number of files that can be opened simultaneously.</td>
43        </tr>
44        <tr>
45<td>in</td>
46<th>maxDirectory</th>
47<td>The maximum number of directories that can be opened simultaneously.</td>
48        </tr>
49        <tr>
50<td>in</td>
51<th>workingMemory</th>
52<td>The starting address of the memory region used for ROM archive operations.</td>
53        </tr>
54        <tr>
55<td>in</td>
56<th>workingMemorySize</th>
57<td>The size of the memory region used for ROM archive operations.</td>
58        </tr>
59        <tr>
60<td>in</td>
61<th>useCache</th>
62<td>Set to <CODE>true</CODE> to enable caching of metadata to memory, or <CODE>false</CODE> to disable metadata caching.</td>
63        </tr> </table>
64    </div>
65<h2>Return Values</h2>
66<div class="section">Returns the result of the operation. </div>
67<h2>Description</h2>
68    <div class="section">
69<p>Mounts a ROM archive.</p><p>This function mounts a ROM archive that accesses a ROMFS generated at build time. The numbers of files and directories you can simultaneously open from the ROM archive are specified by <SPAN class="argument">maxFile</SPAN> and <SPAN class="argument">maxDirectory</SPAN>, respectively. The memory passed in to <SPAN class="argument">workingMemory</SPAN> must be at least as large as the required memory size calculated by the <a href="../../nn/fs/GetRomRequiredMemorySize.html"><CODE>GetRomRequiredMemorySize</CODE></a> function. You can cache ROMFS metadata to memory by setting the <SPAN class="argument">useCache</SPAN> argument to <CODE>true</CODE>. Doing so will reduce the time required to open files and scan directories, at the expense of increased memory requirements.</p>This function mounts a ROM archive that accesses a ROMFS generated at build time.
70
71The numbers of files and directories you can simultaneously open from the ROM archive are specified by <SPAN class="argument">maxFile</SPAN> and <SPAN class="argument">maxDirectory</SPAN>, respectively.
72
73The memory passed in to <SPAN class="argument">workingMemory</SPAN> must be at least as large as the required memory size calculated by the <CODE>GetRomRequiredMemorySize</CODE> function. You can cache ROMFS metadata to memory by setting the <SPAN class="argument">useCache</SPAN> argument to <CODE>true</CODE>. Doing so will reduce the time required to open files and scan directories, at the expense of increased memory requirements.</div>
74<h2>Revision History</h2>
75    <div class="section">
76      <dl class="history">
77        <dt>2010/09/10</dt>
78<dd>Initial version.<br />
79        </dd>
80      </dl>
81    </div>
82  <hr><p>CONFIDENTIAL</p></body>
83</html>