fatfs/doc/en/dstat.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/dstat.html">
   8 <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
   9 <title>FatFs - disk_status</title>
  10 </head>
  11
  12 <body>
  13
  14 <div class="para func">
  15 <h2>disk_status</h2>
  16 <p>The disk_status function returns the current drive status.</p>
  17 <pre>
  18 DSTATUS disk_status (
  19   BYTE <span class="arg">pdrv</span>     <span class="c">/* [IN] Physical drive number */</span>
  20 );
  21 </pre>
  22 </div>
  23
  24 <div class="para arg">
  25 <h4>Parameter</h4>
  26 <dl class="par">
  27 <dt>pdrv</dt>
  28 <dd>Physical drive number to identify the target device. Always zero at single drive system.</dd>
  29 </dl>
  30 </div>
  31
  32
  33 <div class="para ret">
  34 <h4>Return Values</h4>
  35 <p>The current drive status is returned in combination of status flags described below. FatFs refers only <tt>STA_NOINIT</tt> and <tt>STA_PROTECT</tt>.</p>
  36 <dl class="ret">
  37 <dt>STA_NOINIT</dt>
  38 <dd>Indicates that the device is not initialized and not ready to work. This flag is set on system reset, media removal or failure of <tt>disk_initialize</tt> function. It is cleared on <tt>disk_initialize</tt> function succeeded. Any media change that occurs asynchronously must be captured and reflect it to the status flags, or auto-mount function will not work correctly. If the system does not support media change detection, application program needs to force de-initialize the file system object and re-mount the volume with <tt>f_mount</tt> function after each media change.</dd>
  39 <dt>STA_NODISK</dt>
  40 <dd>Indicates that no medium in the drive. This is always cleared at fixed disk drive. Note that FatFs does not refer this flag.</dd>
  41 <dt>STA_PROTECT</dt>
  42 <dd>Indicates that the medium is write protected. This is always cleared at the drives without write protect function. Not valid if no medium in the drive.</dd>
  43 </dl>
  44 </div>
  45
  46 <p class="foot"><a href="../00index_e.html">Return</a></p>
  47 </body>
  48 </html>