diff options
Diffstat (limited to 'fatfs/doc/en/sfile.html')
| -rw-r--r-- | fatfs/doc/en/sfile.html | 22 |
1 files changed, 8 insertions, 14 deletions
diff --git a/fatfs/doc/en/sfile.html b/fatfs/doc/en/sfile.html index 1ed9899..5e53d16 100644 --- a/fatfs/doc/en/sfile.html +++ b/fatfs/doc/en/sfile.html @@ -13,31 +13,25 @@ <div class="para">
<h2>FIL</h2>
-<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>. 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>
+<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>
<pre>
<span class="k">typedef</span> <span class="k">struct</span> {
- FATFS* fs; <span class="c">/* Pointer to the owner file system object */</span>
- WORD id; <span class="c">/* Owner file system mount ID */</span>
+ _FDID obj; <span class="c">/* Owner file sytem object and object identifier */</span>
BYTE flag; <span class="c">/* File object status flags */</span>
BYTE err; <span class="c">/* Abort flag (error code) */</span>
- DWORD fptr; <span class="c">/* File read/write pointer (Byte offset origin from top of the file) */</span>
- DWORD fsize; <span class="c">/* File size in unit of byte */</span>
- DWORD sclust; <span class="c">/* File start cluster */</span>
- DWORD clust; <span class="c">/* Current cluster */</span>
- DWORD dsect; <span class="c">/* Current data sector */</span>
+ FSIZE_t fptr; <span class="c">/* File read/write pointer (Byte offset origin from top of the file) */</span>
+ DWORD clust; <span class="c">/* Current cluster of fptr (One cluster behind if fptr is on the cluster boundary. Invalid if fptr == 0.) */</span>
+ DWORD sect; <span class="c">/* Current data sector (Can be invalid if fptr is on the cluster boundary.)*/</span>
<span class="k">#if</span> !_FS_READONLY
- DWORD dir_sect; <span class="c">/* Sector containing the directory entry */</span>
+ DWORD dir_sect; <span class="c">/* Sector number containing the directory entry */</span>
BYTE* dir_ptr; <span class="c">/* Ponter to the directory entry in the window */</span>
<span class="k">#endif</span>
<span class="k">#if</span> _USE_FASTSEEK
- DWORD* cltbl; <span class="c">/* Pointer to the cluster link map table (Nulled on file open) */</span>
-<span class="k">#endif</span>
-<span class="k">#if</span> _FS_LOCK
- UINT lockid; <span class="c">/* Fle lock ID */</span>
+ DWORD* cltbl; <span class="c">/* Pointer to the cluster link map table (Nulled on file open. Set by application.) */</span>
<span class="k">#endif</span>
<span class="k">#if</span> !_FS_TINY
- BYTE buf[_MAX_SS]; <span class="c">/* File private data transfer buffer */</span>
+ 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>
<span class="k">#endif</span>
} FIL;
</pre>
|