git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/Common/FileSystem/FatFs-0.7e/doc/en/unlink.html

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