6b3a247147480748a1217f85690951474e97d411
[bertos.git] / bertos / fs / fatfs / doc / en / dstat.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r
2 <html lang="en">\r
3 <head>\r
4 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">\r
5 <meta http-equiv="Content-Style-Type" content="text/css">\r
6 <link rel="up" title="FatFs" href="../00index_e.html">\r
7 <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">\r
8 <title>FatFs - disk_status</title>\r
9 </head>\r
10 \r
11 <body>\r
12 \r
13 <div class="para">\r
14 <h2>disk_status</h2>\r
15 <p>The disk_status function returns the current disk status.</p>\r
16 <pre>\r
17 DSTATUS disk_status (\r
18   BYTE <em>Drive</em>     /* Physical drive number */\r
19 );\r
20 </pre>\r
21 </div>\r
22 \r
23 <div class="para">\r
24 <h4>Parameter</h4>\r
25 <dl class="par">\r
26 <dt>Drive</dt>\r
27 <dd>Specifies the physical drive number to be confirmed.</dd>\r
28 </dl>\r
29 </div>\r
30 \r
31 \r
32 <div class="para">\r
33 <h4>Return Values</h4>\r
34 <p>The disk status is returned in combination of following flags.</p>\r
35 <dl class="ret">\r
36 <dt>STA_NOINIT</dt>\r
37 <dd>Indicates that the disk drive has not been initialized. This flag is set on: system reset, disk removal and disk_initialize function failed, and cleared on: disk_initialize function succeeded.</dd>\r
38 <dt>STA_NODISK</dt>\r
39 <dd>Indicates that no medium in the drive. This is always cleared on fixed disk drive.</dd>\r
40 <dt>STA_PROTECTED</dt>\r
41 <dd>Indicates that the medium is write protected. This is always cleared on the drive that does not support write protect notch. Not valid when <tt>STA_NODISK</tt> is set.</dd>\r
42 </dl>\r
43 </div>\r
44 \r
45 <p class="foot"><a href="../00index_e.html">Return</a></p>\r
46 </body>\r
47 </html>\r