2014-08-13 05:48:16 +00:00
<!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 = "alternate" hreflang = "ja" title = "Japanese" href = "../ja/unlink.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 func" >
< h2 > f_unlink< / h2 >
< p > The f_unlink function removes a file or sub-directory.< / p >
< pre >
FRESULT f_unlink (
const TCHAR* < span class = "arg" > path< / span > < span class = "c" > /* [IN] Object name */< / span >
);
< / pre >
< / div >
< div class = "para arg" >
< h4 > Parameter< / h4 >
< dl class = "par" >
< dt > path< / dt >
2017-06-24 06:35:31 +00:00
< dd > Pointer to a null-terminated string that specifies the < a href = "filename.html" > file or sub-directory< / a > to be removed.< / dd >
2014-08-13 05:48:16 +00:00
< / dl >
< / div >
< div class = "para ret" >
< h4 > Return Values< / h4 >
< p >
< a href = "rc.html#ok" > FR_OK< / a > ,
< a href = "rc.html#de" > FR_DISK_ERR< / a > ,
< a href = "rc.html#ie" > FR_INT_ERR< / a > ,
< a href = "rc.html#nr" > FR_NOT_READY< / a > ,
< a href = "rc.html#ok" > FR_NO_FILE< / a > ,
< a href = "rc.html#np" > FR_NO_PATH< / a > ,
< a href = "rc.html#in" > FR_INVALID_NAME< / a > ,
2017-06-24 06:35:31 +00:00
< a href = "rc.html#dn" > FR_DENIED< / a > ,
2014-08-13 05:48:16 +00:00
< a href = "rc.html#wp" > FR_WRITE_PROTECTED< / a > ,
< a href = "rc.html#id" > FR_INVALID_DRIVE< / a > ,
< a href = "rc.html#ne" > FR_NOT_ENABLED< / a > ,
< a href = "rc.html#ns" > FR_NO_FILESYSTEM< / a > ,
< a href = "rc.html#tm" > FR_TIMEOUT< / a > ,
< a href = "rc.html#lo" > FR_LOCKED< / a > ,
< a href = "rc.html#nc" > FR_NOT_ENOUGH_CORE< / a >
< / p >
< / div >
< div class = "para desc" >
< h4 > Description< / h4 >
< p >
If condition of the object to be removed is applicable to the following terms, the function will be rejected.< ul >
< li > The file/sub-directory must not have read-only attribute (< tt > AM_RDO< / tt > ), or the function will be rejected with < tt > FR_DENIED< / tt > .< / li >
< li > The sub-directory must be empty and must not be current directory, or the function will be rejected with < tt > FR_DENIED< / tt > .< / li >
2017-06-24 06:35:31 +00:00
< li > The file/sub-directory must not be opened, or the < em > FAT volume can be collapsed< / em > . It will be rejected safely when < a href = "appnote.html#dup" > file lock function< / a > is enabled.< / li >
2014-08-13 05:48:16 +00:00
< / ul >
< / div >
< div class = "para comp" >
< h4 > QuickInfo< / h4 >
2017-06-24 06:35:31 +00:00
< p > Available when < tt > FF_FS_READONLY == 0< / tt > and < tt > FF_FS_MINIMIZE == 0< / tt > .< / p >
2014-08-13 05:48:16 +00:00
< / div >
< p class = "foot" > < a href = "../00index_e.html" > Return< / a > < / p >
< / body >
< / html >
