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] - Rev 637
Go to most recent revision | Compare with Previous | Blame | 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>
Go to most recent revision | Compare with Previous | Blame | View Log