]> cloudbase.mooo.com Git - z180-stamp.git/blobdiff - fatfs/documents/doc/sfile.html
Merge branch 'chan-fatfs' into fatfs-integration
[z180-stamp.git] / fatfs / documents / doc / sfile.html
similarity index 65%
rename from fatfs/doc/en/sfile.html
rename to fatfs/documents/doc/sfile.html
index 5e53d167cc2f8058b74726498f2316d7cad28c81..e8a677f7dc622a9ddb347b833bd045b213ab7cdb 100644 (file)
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r
 <html lang="en">\r
 <head>\r
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">\r
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">\r
 <meta http-equiv="Content-Style-Type" content="text/css">\r
 <link rel="up" title="FatFs" href="../00index_e.html">\r
 <link rel="alternate" hreflang="ja" title="Japanese" href="../ja/sfile.html">\r
 \r
 <div class="para">\r
 <h2>FIL</h2>\r
-<p>The <tt>FIL</tt> structure (file object) holds the state of an open file. It is created by <tt>f_open</tt> function and discarded by <tt>f_close</tt> function. Application program must not modify any member in this structure except for <tt>cltbl</tt>, or any data on the FAT volume can be collapsed. Note that a sector buffer is defined in this structure at non-tiny configuration (<tt>_FS_TINY == 0</tt>), so that the <tt>FIL</tt> structures at that configuration should not be defined as auto variable.</p>\r
+<p>The <tt>FIL</tt> structure (file object) holds the state of an open file. It is created by <tt>f_open</tt> function and discarded by <tt>f_close</tt> function. Application program <em>must not</em> modify any member in this structure except for <tt>cltbl</tt>, or the FAT volume will be collapsed. Note that a sector buffer is defined in this structure at non-tiny configuration (<tt><a href="config.html#fs_tiny">FF_FS_TINY</a> == 0</tt>), so that the <tt>FIL</tt> structures at that configuration should not be defined as auto variable.</p>\r
 \r
 <pre>\r
 <span class="k">typedef</span> <span class="k">struct</span> {\r
-    _FDID   obj;          <span class="c">/* Owner file sytem object and object identifier */</span>\r
+    FFOBJID obj;          <span class="c">/* Object identifier */</span>\r
     BYTE    flag;         <span class="c">/* File object status flags */</span>\r
     BYTE    err;          <span class="c">/* Abort flag (error code) */</span>\r
     FSIZE_t fptr;         <span class="c">/* File read/write pointer (Byte offset origin from top of the file) */</span>\r
     DWORD   clust;        <span class="c">/* Current cluster of fptr (One cluster behind if fptr is on the cluster boundary. Invalid if fptr == 0.) */</span>\r
     DWORD   sect;         <span class="c">/* Current data sector (Can be invalid if fptr is on the cluster boundary.)*/</span>\r
-<span class="k">#if</span> !_FS_READONLY\r
+<span class="k">#if</span> !FF_FS_READONLY\r
     DWORD   dir_sect;     <span class="c">/* Sector number containing the directory entry */</span>\r
     BYTE*   dir_ptr;      <span class="c">/* Ponter to the directory entry in the window */</span>\r
 <span class="k">#endif</span>\r
-<span class="k">#if</span> _USE_FASTSEEK\r
+<span class="k">#if</span> FF_USE_FASTSEEK\r
     DWORD*  cltbl;        <span class="c">/* Pointer to the cluster link map table (Nulled on file open. Set by application.) */</span>\r
 <span class="k">#endif</span>\r
-<span class="k">#if</span> !_FS_TINY\r
-    BYTE    buf[_MAX_SS]; <span class="c">/* File private data transfer buffer (Always valid if fptr is not on the sector boundary but can be invalid if fptr is on the sector boundary.) */</span>\r
+<span class="k">#if</span> !FF_FS_TINY\r
+    BYTE    buf[FF_MAX_SS]; <span class="c">/* File private data transfer buffer (Always valid if fptr is not on the sector boundary but can be invalid if fptr is on the sector boundary.) */</span>\r
 <span class="k">#endif</span>\r
 } FIL;\r
 </pre>\r