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>GetRomRequiredMemorySize</title>
8  </head>
9  <body>
10<h1><CODE>nn::fs::GetRomRequiredMemorySize</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14s32 GetRomRequiredMemorySize(
15     size_t maxFile,
16     size_t maxDirectory,
17     bool useCache = true
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>maxFile</th>
34<td>The maximum number of files that can be opened simultaneously.</td>
35        </tr>
36        <tr>
37<td>in</td>
38<th>maxDirectory</th>
39<td>The maximum number of directories that can be opened simultaneously.</td>
40        </tr>
41        <tr>
42<td>in</td>
43<th>useCache</th>
44<td>Set to <CODE>true</CODE> to enable caching of metadata to memory, or <CODE>false</CODE> to disable metadata caching.</td>
45        </tr> </table>
46    </div>
47<h2>Return Values</h2>
48<div class="section">Returns the calculated memory size. </div>
49<h2>Description</h2>
50    <div class="section">
51<p>Gets the size of memory needed to mount a ROM archive.</p><p>This function calculates and returns the memory size needed to mount a ROM archive that accesses a ROMFS generated at build time. The returned memory size allows only the number of files specified by <SPAN class="argument">maxFile</SPAN> and the number of directories specified by <SPAN class="argument">maxDirectory</SPAN> to be opened simultaneously. If the <SPAN class="argument">useCache</SPAN> argument is set equal to <CODE>true</CODE>, this size includes the amount of memory required to cache ROMFS metadata in memory.</p><h3>About the return values:</h3><div class="section">
52This function has been revised in the following SDK versions to jump to an error display screen, without returning control to the application, when an error occurs. Applications do not need to implement error handling for this function.<br /><br /><table><thead><th>Series</th><th>SDK version</th><th>Return value specifications</th></thead><tr><th rowspan="2">CTR-SDK 1.X</th><td>1.1 or earlier</td><td>A value of 0 or less is returned when an error occurs.</td></tr><tr><td>1.2 or later</td><td>Control jumps to the error display screen when an error occurs. (An invalid value is not returned.）</td></tr><tr><th rowspan="2">CTR-SDK 2.X</th><td>2.0 or earlier</td><td>A value of 0 or less is returned when an error occurs.</td></tr><tr><td>2.1 or later</td><td>Control jumps to the error display screen when an error occurs. (An invalid value is not returned.）</td></tr></table></div></div>
53<h2>Revision History</h2>
54    <div class="section">
55      <dl class="history">
56        <dt>2011/02/28</dt>
57<dd>Added information on changes to return value specifications.
58        </dd>
59        <dt>2010/12/14</dt>
60<dd>Fixed the description of the return value when there is an internal error (this used to be described as &quot;a negative value&quot;).
61        </dd>
62        <dt>2010/08/16</dt>
63<dd>Initial version.<br />
64        </dd>
65      </dl>
66    </div>
67  <hr><p>CONFIDENTIAL</p></body>
68</html>
69