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 name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<title>NA_FormatTitleArchive</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">NA_FormatTitleArchive <IMG src="../../image/TWL.gif" width="23" height="12" border="0" align="middle"></h1>
15<h2>Syntax</h2>
16
17<dl>
18  <dd>
19  <pre><CODE>#include &lt;twl/na.h&gt;
20
21<a href="../../fs/fs_result_const.html">FSResult</a> NA_FormatTitleArchive(<a href="NATitleArchive.html">NATitleArchive</a> archive);
22</CODE></pre>
23</dd>
24</dl>
25
26<h2>Arguments</h2>
27<TABLE border="1" width="100%" class="arguments">
28  <TBODY>
29    <TR>
30<TH>archive</TH>
31<TD>Sets the save data region to initialize.</TD>
32    </TR>
33  </TBODY>
34</TABLE>
35
36<h2>Return Values</h2>
37<p>
38Returns <code>FS_RESULT_SUCCESS</code> if processing completed successfully. <br>Other values indicate an error. The following values, in particular, have specific meanings.
39</p>
40
41<table class="table">
42<tr><th><CODE>FS_RESULT_UNSUPPORTED</CODE><td>This is running on the Nintendo DS system and cannot be used.
43</table>
44
45
46<H2>Description</H2>
47<P>
48Initializes the specified save data region. Applications can initialize only their own save data region. (Save data regions for other applications cannot be initialized.)
49</p>
50<P>
51Initializing the save data region deletes all directories and files contained therein. It also fixes the type of file system corruption indicated when <CODE>FS_RESULT_BAD_FORMAT</CODE> is returned by the FS library functions.
52</p>
53<P>
54The time required for initialization with this function is proportionate to the size of the save data region. It takes approximately 10 seconds per MB, so be sure to follow the various programming guidelines regarding what to display. Note that this is a synchronous function, so control does not return until the processing has completed.
55</p>
56
57
58<h2>See Also</h2>
59<p></p>
60
61<H2>Revision History</H2>
62<P>
632008/11/26 Clarified that this is a synchronous function. <br>2008/09/26 Initial version.
64</P>
65<hr><p>CONFIDENTIAL</p></body>
66</html>
67