1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META http-equiv="Content-Style-Type" content="text/css">
7<LINK rel="stylesheet" type="text/css" href="../CSS/revolution.css">
8<title>VFGetDriveFreeSize(W)</title>
9</head>
10
11<body>
12
13<h1>VFGetDriveFreeSize(W)</h1>
14
15<h2>Syntax</h2>
16<dl><dd><pre><code>
17#include &lt;revolution/vf.h&gt;
18
19typedef u16	VFWchar;
20
21s32 VFGetDriveFreeSize( const char* drive );
22s32 VFGetDriveFreeSizeW( const VFWchar* drive );
23</code></pre></dd></dl>
24
25<h2>Arguments</h2>
26<p>
27<TABLE border="1" >
28  <tr>
29<TD valign="top" width="120" bgcolor="#ffffe8"><CODE><STRONG><EM>path</EM></STRONG></CODE></TD>
30<TD width="520">The name of the drive to be mounted. Specify a single letter.</TD>
31  </tr>
32</TABLE>
33</p>
34
35<h2>Return Values</h2>
36<PRE>
37When successful, the remaining size (0 or more). A size of 2 GB or more is returned as 2 GB (2,147,483,647 bytes )
38Failure: -1 (currently, VF errors can be verified with the <code><a href="./VFGetLastError.html">VFGetLastError</a></code> function.)
39</PRE>
40
41
42<H2>Description</H2>
43<p>
44Gets the remaining number of bytes for the specified drive. When the available space is obtained successfully, the number of free bytes is returned; if failed, -1 is returned. <br>Use the <code><a href="./VFGetDriveFreeSizeU64.html">VFGetDriveFreeSizeU64</a></code> function to accurately know the precise number of bytes remaining for 2 GB or more.  <br>
45</p>
46
47<h2>See Also</h2>
48<p>
49<code><a href="./VFGetDriveFreeSizeU64.html">VFGetDriveFreeSizeU64</a></code>
50</p>
51
52<H2>Revision History</H2>
53<p>
542008/12/16 Added a description about the limits on the return values<br>2006/05/31 Initial version<br>
55</p>
56
57
58<hr><p>CONFIDENTIAL</p></body>
59</html>
60