URL https://opencores.org/ocsvn/openrisc_2011-10-31/openrisc_2011-10-31/trunk

Subversion Repositories openrisc_2011-10-31

[/] [openrisc/] [trunk/] [rtos/] [freertos-6.1.1/] [Demo/] [Common/] [FileSystem/] [FatFs-0.7e/] [doc/] [en/] [unlink.html] - Blame information for rev 606

Details | Compare with Previous | View Log


<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="up" title="FatFs" href="../00index_e.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_unlink</title>
</head>
 
<body>
 
<div class="para">
<h2>f_unlink</h2>
<p>The f_unlink removes an object.</p>
<pre>
FRESULT f_unlink (
  const XCHAR* <em>FileName</em>  /* Pointer to the object name */
);
</pre>
</div>
 
<div class="para">
<h4>Parameter</h4>
<dl class="par">
<dt>FileName</dt>
<dd>Pointer to the null-terminated string that specifies an <a href="filename.html">object</a> to be removed.</dd>
</dl>
</div>
 
 
<div class="para">
<h4>Return Values</h4>
<dl class="ret">
<dt>FR_OK (0)</dt>
<dd>The function succeeded.</dd>
<dt>FR_NO_FILE</dt>
<dd>Could not find the file or directory.</dd>
<dt>FR_NO_PATH</dt>
<dd>Could not find the path.</dd>
<dt>FR_INVALID_NAME</dt>
<dd>The path name is invalid.</dd>
<dt>FR_INVALID_DRIVE</dt>
<dd>The drive number is invalid.</dd>
<dt>FR_DENIED</dt>
<dd>The function was denied due to either of following reasons:
<ul><li>The object has read-only attribute</li><li>The directory is not empty.</li></ul></dd>
<dt>FR_NOT_READY</dt>
<dd>The disk drive cannot work due to no medium in the drive or any other reason.</dd>
<dt>FR_WRITE_PROTECTED</dt>
<dd>The medium is write protected.</dd>
<dt>FR_DISK_ERR</dt>
<dd>The function failed due to an error in the disk function.</dd>
<dt>FR_INT_ERR</dt>
<dd>The function failed due to a wrong FAT structure or an internal error.</dd>
<dt>FR_NOT_ENABLED</dt>
<dd>The logical drive has no work area.</dd>
<dt>FR_NO_FILESYSTEM</dt>
<dd>There is no valid FAT volume on the disk.</dd>
</dl>
</div>
 
 
<div class="para">
<h4>Description</h4>
<p>The f_unlink function removes an object. <em>Do not remove open objects and current directory</em>.</p>
</div>
 
 
<div class="para">
<h4>QuickInfo</h4>
<p>Available when <tt>_FS_READONLY == 0</tt> and <tt>_FS_MINIMIZE == 0</tt>.</p>
</div>
 
 
<p class="foot"><a href="../00index_e.html">Return</a></p>
</body>
</html>

Line No.	Rev	Author	Line
1	606	jeremybenn	`<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">`
2			`<html lang="en">`
3			`<head>`
4			`<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">`
5			`<meta http-equiv="Content-Style-Type" content="text/css">`
6			`<link rel="up" title="FatFs" href="../00index_e.html">`
7			`<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">`
8			`<title>FatFs - f_unlink</title>`
9			`</head>`
10
11			`<body>`
12
13			`<div class="para">`
14			`<h2>f_unlink</h2>`
15			`<p>The f_unlink removes an object.</p>`
16			`<pre>`
17			`FRESULT f_unlink (`
18			`const XCHAR* <em>FileName</em> /* Pointer to the object name */`
19			`);`
20			`</pre>`
21			`</div>`
22
23			`<div class="para">`
24			`<h4>Parameter</h4>`
25			`<dl class="par">`
26			`<dt>FileName</dt>`
27			`<dd>Pointer to the null-terminated string that specifies an <a href="filename.html">object</a> to be removed.</dd>`
28			`</dl>`
29			`</div>`
30
31
32			`<div class="para">`
33			`<h4>Return Values</h4>`
34			`<dl class="ret">`
35			`<dt>FR_OK (0)</dt>`
36			`<dd>The function succeeded.</dd>`
37			`<dt>FR_NO_FILE</dt>`
38			`<dd>Could not find the file or directory.</dd>`
39			`<dt>FR_NO_PATH</dt>`
40			`<dd>Could not find the path.</dd>`
41			`<dt>FR_INVALID_NAME</dt>`
42			`<dd>The path name is invalid.</dd>`
43			`<dt>FR_INVALID_DRIVE</dt>`
44			`<dd>The drive number is invalid.</dd>`
45			`<dt>FR_DENIED</dt>`
46			`<dd>The function was denied due to either of following reasons:`
47			`<ul><li>The object has read-only attribute</li><li>The directory is not empty.</li></ul></dd>`
48			`<dt>FR_NOT_READY</dt>`
49			`<dd>The disk drive cannot work due to no medium in the drive or any other reason.</dd>`
50			`<dt>FR_WRITE_PROTECTED</dt>`
51			`<dd>The medium is write protected.</dd>`
52			`<dt>FR_DISK_ERR</dt>`
53			`<dd>The function failed due to an error in the disk function.</dd>`
54			`<dt>FR_INT_ERR</dt>`
55			`<dd>The function failed due to a wrong FAT structure or an internal error.</dd>`
56			`<dt>FR_NOT_ENABLED</dt>`
57			`<dd>The logical drive has no work area.</dd>`
58			`<dt>FR_NO_FILESYSTEM</dt>`
59			`<dd>There is no valid FAT volume on the disk.</dd>`
60			`</dl>`
61			`</div>`
62
63
64			`<div class="para">`
65			`<h4>Description</h4>`
66			`<p>The f_unlink function removes an object. <em>Do not remove open objects and current directory</em>.</p>`
67			`</div>`
68
69
70			`<div class="para">`
71			`<h4>QuickInfo</h4>`
72			`<p>Available when <tt>_FS_READONLY == 0</tt> and <tt>_FS_MINIMIZE == 0</tt>.</p>`
73			`</div>`
74
75
76			`<p class="foot"><a href="../00index_e.html">Return</a></p>`
77			`</body>`
78			`</html>`

Browse

Tools

Subversion Repositories openrisc_2011-10-31

[/] [openrisc/] [trunk/] [rtos/] [freertos-6.1.1/] [Demo/] [Common/] [FileSystem/] [FatFs-0.7e/] [doc/] [en/] [unlink.html] - Blame information for rev 606