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>GetArchiveFreeBytes</title>
8  </head>
9  <body>
10<h1><CODE>nn::fs::GetArchiveFreeBytes</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../nn/Result/Overview.html">Result</a> GetArchiveFreeBytes(
15     s64 * pOut,
16     const char * archiveName
17);
18</pre>
19    </div>
20<h2>Arguments</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>out</td>
32<th>pOut</th>
33<td>Returns the amount of free archive space.</td>
34        </tr>
35        <tr>
36<td>in</td>
37<th>archiveName</th>
38<td>Specifies the archive name.</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>Success.</th>
52<td>Process was successful. The return value's <CODE>IsSuccess</CODE> function returns <CODE>true</CODE> in this state.</td>
53        </tr>
54        <tr>
55<th><CODE>ResultNotFound</CODE></th>
56<td>The specified archive has not been mounted. You must not allow this error to occur in retail products.</td>
57        </tr>
58        <tr>
59<th>A value other than the above.</th>
60<td>An application bug or some other unexpected error.</td>
61        </tr>
62      </table> </div>
63<h2>Description</h2>
64    <div class="section">
65<p>Gets the amount of free space in the archive.</p><p>This function can only be used on save data archives.</p><p>The save data region manages data with a fixed size of 512 bytes. As a result, this function's return value is always a multiple of 512 bytes. When this function returns <CODE>1024</CODE>, that means you can create two files of 512 bytes. If you create one file of 513 bytes, the remaining available space goes to 0.</p><!-- write here --></div>
66<h2>Revision History</h2>
67    <div class="section">
68      <dl class="history">
69        <dt>2010/12/15</dt>
70<dd>Added return values.
71        </dd>
72        <dt>2010/11/13</dt>
73<dd>Added descriptions of the block size. Changed the type of the <SPAN class="argument">archiveName</SPAN> argument from <CODE>wchar_t*</CODE> to <CODE>const char*</CODE>.<br />
74        </dd>
75        <dt>2010/11/09</dt>
76<dd>Initial version.<br />
77        </dd>
78      </dl>
79    </div>
80  <hr><p>CONFIDENTIAL</p></body>
81</html>