fatfs/doc/en/sfile.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <html lang="en">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
   5 <meta http-equiv="Content-Style-Type" content="text/css">
   6 <link rel="up" title="FatFs" href="../00index_e.html">
   7 <link rel="alternate" hreflang="ja" title="Japanese" href="../ja/sfile.html">
   8 <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
   9 <title>FatFs - FIL</title>
  10 </head>
  11
  12 <body>
  13
  14 <div class="para">
  15 <h2>FIL</h2>
  16 <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>
  17
  18 <pre>
  19 <span class="k">typedef</span> <span class="k">struct</span> {
  20     FATFS*  fs;           <span class="c">/* Pointer to the owner file system object */</span>
  21     WORD    id;           <span class="c">/* Owner file system mount ID */</span>
  22     BYTE    flag;         <span class="c">/* File object status flags */</span>
  23     BYTE    err;          <span class="c">/* Abort flag (error code) */</span>
  24     DWORD   fptr;         <span class="c">/* File read/write pointer (Byte offset origin from top of the file) */</span>
  25     DWORD   fsize;        <span class="c">/* File size in unit of byte */</span>
  26     DWORD   sclust;       <span class="c">/* File start cluster */</span>
  27     DWORD   clust;        <span class="c">/* Current cluster */</span>
  28     DWORD   dsect;        <span class="c">/* Current data sector */</span>
  29 <span class="k">#if</span> !_FS_READONLY
  30     DWORD   dir_sect;     <span class="c">/* Sector containing the directory entry */</span>
  31     BYTE*   dir_ptr;      <span class="c">/* Ponter to the directory entry in the window */</span>
  32 <span class="k">#endif</span>
  33 <span class="k">#if</span> _USE_FASTSEEK
  34     DWORD*  cltbl;        <span class="c">/* Pointer to the cluster link map table (Nulled on file open) */</span>
  35 <span class="k">#endif</span>
  36 <span class="k">#if</span> _FS_LOCK
  37     UINT    lockid;       <span class="c">/* Fle lock ID */</span>
  38 <span class="k">#endif</span>
  39 <span class="k">#if</span> !_FS_TINY
  40     BYTE    buf[_MAX_SS]; <span class="c">/* File private data transfer buffer */</span>
  41 <span class="k">#endif</span>
  42 } FIL;
  43 </pre>
  44
  45 </div>
  46
  47 <p class="foot"><a href="../00index_e.html">Return</a></p>
  48 </body>
  49 </html>