fatfs/doc/en/sdir.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/sdir.html">
   8 <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
   9 <title>FatFs - DIR</title>
  10 </head>
  11
  12 <body>
  13
  14 <div class="para">
  15 <h2>DIR</h2>
  16 <p>The <tt>DIR</tt> structure is used for the work area to read a directory by <tt>f_oepndir()/f_readdir()</tt> function. Application program must not modify any member in this structure.</p>
  17 <pre>
  18 <span class="k">typedef</span> <span class="k">struct</span> {
  19     FATFS*  fs;         <span class="c">/* Pointer to the owner file system object */</span>
  20     WORD    id;         <span class="c">/* Owner file system mount ID */</span>
  21     WORD    index;      <span class="c">/* Index of directory entry to start to search next */</span>
  22     DWORD   sclust;     <span class="c">/* Table start cluster (0:Root directory) */</span>
  23     DWORD   clust;      <span class="c">/* Current cluster */</span>
  24     DWORD   sect;       <span class="c">/* Current sector */</span>
  25     BYTE*   dir;        <span class="c">/* Pointer to the current SFN entry in the win[] */</span>
  26     BYTE*   fn;         <span class="c">/* Pointer to the SFN buffer (in/out) {file[8],ext[3],status[1]} */</span>
  27 <span class="k">#if</span> _FS_LOCK
  28     UINT    lockid;     <span class="c">/* Sub-directory lock ID (0:Root directory) */</span>
  29 <span class="k">#endif</span>
  30 <span class="k">#if</span> _USE_LFN
  31     WCHAR*  lfn;        <span class="c">/* Pointer to the LFN buffer (in/out) */</span>
  32     WORD    lfn_idx;    <span class="c">/* Index of the LFN entris (0xFFFF:No LFN) */</span>
  33 <span class="k">#endif</span>
  34 } DIR;
  35 </pre>
  36 </div>
  37
  38 <p class="foot"><a href="../00index_e.html">Return</a></p>
  39 </body>
  40 </html>