1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=windows-1252" />
5<meta http-equiv="Content-Style-Type" content="text/css" />
6<title>FS_CreateFile</title>
7<link rel="stylesheet" href="../../css/nitro.css" type="text/css" />
8</head>
9<body>
10
11<h1>FS_CreateFile <img src="../../image/NTR.gif"align="middle"><img src="../../image/TWL.gif" align="middle"></h1>
12<h2>Syntax</h2>
13<pre><code>
14#include &lt;nitro/fs.h&gt;
15
16BOOL FS_CreateFile(const char *path, u32 permit);
17</code></pre>
18
19<h2>Arguments</h2>
20<table style="width:100%">
21<tbody>
22<tr>
23<td style="width:13%"><em><strong>path</strong></em></td>
24<td style="width:87%">Path name of the file to be created.</td>
25</tr>
26<tr>
27<td style="width:13%"><em><strong>permit</strong></em></td>
28<td style="width:87%">Specifies the combination of <a href="../FS_PERMIT.html"><code>FS_PERMIT_*</code></a> flags that indicate the access rights to the file.</td>
29</tr>
30</tbody>
31</table>
32
33<h2>Return Values</h2>
34<p>Returns TRUE if the file was created properly; returns FALSE otherwise. In case of failure, the error details can be obtained using <code><a href="../archive/FS_GetArchiveResultCode.html">FS_GetArchiveResultCode()</a></code>.</p>
35
36<h2>Description</h2>
37<p>Creates the new file specified by the arguments. The function returns FALSE in the following situations:
38</p>
39<ul>
40<li>If the target archive does not support the creation of new files.</li>
41<li>If a file of the same name already exists.</li>
42</ul>
43
44<h2>Note</h2>
45<ul>
46<li>This function cannot be called from the interrupt handler (IRQ mode). Also note that in some cases processing may not end if interrupts are left prohibited.</li>
47</ul>
48
49<h2>See Also</h2>
50<p><code><a href="../FS_PERMIT.html">FS_PERMIT_*</a> <br /> <a href="FS_DeleteFile.html">FS_DeleteFile</A> <a href="FS_RenameFile.html">FS_RenameFile</A> <a href="../file/FS_GetResultCode.html">FS_GetResultCode</A></code></p>
51
52<h2>Revision History</h2>
53<p>
542007/09/18 Initial version.
55</p>
56<hr><p>CONFIDENTIAL</p></body>
57</html>
58