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>GetSdmcSize</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../nn/Overview.html">nn</a>::<a href="../../nn/fs/Overview.html">fs</a>::GetSdmcSize</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../nn/Result/Overview.html">Result</a> GetSdmcSize(
15     <a href="../../nn_types/s64.html">s64</a> * pTotal,
16     <a href="../../nn_types/s64.html">s64</a> * pFree
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>out</td>
32<th>pTotal</th>
33<td>Returns the total SD Card capacity.</td>
34        </tr>
35        <tr>
36<td>out</td>
37<th>pFree</th>
38<td>Returns the amount of free space on the SD Card.</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>ResultNotFound</CODE></th>
56<td>An SD Card could not be found or recognized. This error will also be returned if an SD Card is inserted but the file system on the card cannot be accessed.</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 total capacity and amount of free space on an SD Card.</p><h3>Note</h3><div class="section">
66The Function Reference for CTR-SDK 0.14.16 and prior versions stated that this function returns the errors <CODE>ResultMediaNotFound</CODE>, <CODE>ResultMediaAccessError</CODE>, and <CODE>ResultBadFormat</CODE>. The actual error returned by the function is only <CODE>ResultNotFound</CODE>.<br /><br />This function will return <CODE>ResultNotFound</CODE> if it is called when there is no SD Card as well as when there is no archive mounted on the SD Card. This is a limitation of this function. To avoid this limitation, call this function after first calling either the <CODE><a href="../../nn/fs/MountSdmc.html">nn::fs::MountSdmc</a></CODE>, <CODE><a href="../../nn/fs/MountSdmcWriteOnly.html">nn::fs::MountSdmcWriteOnly</a></CODE> or <CODE><a href="../../nn/fs/MountExtSaveData.html">nn::fs::MountExtSaveData</a></CODE> function.<br /></div></div>
67<h2>Revision History</h2>
68    <div class="section">
69      <dl class="history">
70        <dt>2010/12/28</dt>
71<dd>Added mention of a limitation.<br />Corrected <CODE>Result</CODE> to only be <CODE>ResultNotFound</CODE>.<br />
72        </dd>
73        <dt>2010/12/15</dt>
74<dd>Added return values.
75        </dd>
76        <dt>2010/11/25</dt>
77<dd>Initial version.<br />
78        </dd>
79      </dl>
80    </div>
81  <hr><p>CONFIDENTIAL</p></body>
82</html>
83