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>VFFormatDrive(W)</title>
9</head>
10
11<body>
12
13<h1>VFFormatDrive(W)</h1>
14
15<h2>Syntax</h2>
16<dl><dd><pre><code>
17#include &lt;revolution/vf.h&gt;
18
19typedef s32	VFErr;
20
21VFErr VFFormatDrive( const char* drive );
22VFErr VFFormatDriveW( const VFWchar* drive );
23
24</code></pre></dd></dl>
25
26<h2>Arguments</h2>
27<p>
28<TABLE border="1" >
29  <tr>
30<TD valign="top" width="120" bgcolor="#ffffe8"><CODE><STRONG><EM>drive</EM></STRONG></CODE></TD>
31<TD width="520">Name of the drive to be formatted.</TD>
32  </tr>
33</TABLE>
34</p>
35
36<h2>Return Values</h2>
37<PRE>
38Returns 0 when successful.
39Otherwise, returns <code><a href="./VFErr.html">VFErr</a></code> other than 0.
40</PRE>
41
42
43<H2>Description</H2>
44<p>
45Formats a mounted drive.<br><br> <br>When a .vff file is used for the first time, be sure to format after calling <CODE>VFMountDrive()</CODE>.<br><br> <br> If the formatted drive is the current drive, the current directory is set to the root of that drive. <br>If an open file or directory exists on the volume specified by drive, the descriptor for the open file or directory is invalidated due to initialization by format.<BR>
46<h2>See Also</h2>
47<p>
48<code><a href="./VFMountDrive.html">VFMountDrive</a></code>
49</p>
50
51<H2>Revision History</H2>
52<p>2006/08/24 Release.</p>
53
54
55<hr><p>CONFIDENTIAL</p></body>
56</html>
57