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/] [sync.html] - Rev 606
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_sync</title> </head> <body> <div class="para"> <h2>f_sync</h2> <p>The f_sync function flushes the cached information of a writing file.</p> <pre> FRESULT f_sync ( FIL* <em>FileObject</em> /* Pointer to the file object */ ); </pre> </div> <div class="para"> <h4>Parameter</h4> <dl class="par"> <dt>FileObject</dt> <dd>Pointer to the open file object to be flushed.</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_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_READY</dt> <dd>The disk drive cannot work due to no medium in the drive or any other reason.</dd> <dt>FR_INVALID_OBJECT</dt> <dd>The file object is invalid.</dd> </dl> </div> <div class="para"> <h4>Description</h4> <p>The f_sync function performs the same process as f_close function but the file is left opened and can continue read/write/seek operations to the file. This is suitable for the applications that open files for a long time in write mode, such as data logger. Performing f_sync of periodic or immediataly after f_write can minimize the risk of data loss due to a sudden blackout or an unintentional disk removal. However f_sync immediataly before f_close has no advantage because f_close performs f_sync in it. In other words, the differnce between those functions is that the file object is invalidated or not. </p> </div> <div class="para"> <h4>QuickInfo</h4> <p>Available when <tt>_FS_READONLY == 0</tt>.</p> </div> <div class="para"> <h4>See Also</h4> <p><tt><a href="close.html">f_close</a></tt></p> </div> <p class="foot"><a href="../00index_e.html">Return</a></p> </body> </html>