fatfs/documents/doc/getlabel.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=utf-8">
   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/getlabel.html">
   8 <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
   9 <title>FatFs - f_getlabel</title>
  10 </head>
  11
  12 <body>
  13
  14 <div class="para func">
  15 <h2>f_getlabel</h2>
  16 <p>The f_getlabel function returns volume label and volume serial number of a volume.</p>
  17 <pre>
  18 FRESULT f_getlabel (
  19   const TCHAR* <span class="arg">path</span>,  <span class="c">/* [IN] Drive number */</span>
  20   TCHAR* <span class="arg">label</span>,       <span class="c">/* [OUT] Volume label */</span>
  21   DWORD* <span class="arg">vsn</span>          <span class="c">/* [OUT] Volume serial number */</span>
  22 );
  23 </pre>
  24 </div>
  25
  26 <div class="para arg">
  27 <h4>Parameters</h4>
  28 <dl class="par">
  29 <dt>path</dt>
  30 <dd>Pointer to the null-terminated string that specifies the <a href="filename.html">logical drive</a>. Null-string specifies the default drive.</dd>
  31 <dt>label</dt>
  32 <dd>Pointer to the buffer to store the volume label. If the volume has no label, a null-string will be returned. Set null pointer if this information is not needed. The buffer size should be shown below at least to avoid buffer overflow.<br>
  33 <table class="lst2">
  34 <tr><td>Configuration</td><td>FF_FS_EXFAT == 0</td><td>FF_FS_EXFAT == 1</td></tr>
  35 <tr><td>FF_USE_LFN == 0</td><td>12 items</td><td>-</td></tr>
  36 <tr><td>FF_LFN_UNICODE == 0</td><td>12 items</td><td>23 items</td></tr>
  37 <tr><td>FF_LFN_UNICODE == 1/3</td><td>12 items</td><td>12 items</td></tr>
  38 <tr><td>FF_LFN_UNICODE == 2</td><td>34 items</td><td>34 items</td></tr>
  39 </table>
  40 </dd>
  41 <dt>vsn</dt>
  42 <dd>Pointer to the <tt>DWORD</tt> variable to store the volume serial number. Set null pointer if this information is not needed.</dd>
  43 </dl>
  44 </div>
  45
  46
  47 <div class="para ret">
  48 <h4>Return Values</h4>
  49 <p>
  50 <a href="rc.html#ok">FR_OK</a>,
  51 <a href="rc.html#de">FR_DISK_ERR</a>,
  52 <a href="rc.html#ie">FR_INT_ERR</a>,
  53 <a href="rc.html#nr">FR_NOT_READY</a>,
  54 <a href="rc.html#id">FR_INVALID_DRIVE</a>,
  55 <a href="rc.html#ne">FR_NOT_ENABLED</a>,
  56 <a href="rc.html#ns">FR_NO_FILESYSTEM</a>,
  57 <a href="rc.html#tm">FR_TIMEOUT</a>
  58 </p>
  59 </div>
  60
  61
  62 <div class="para comp">
  63 <h4>QuickInfo</h4>
  64 <p>Available when <tt><a href="config.html#use_label">FF_USE_LABEL</a> == 1</tt>.</p>
  65 </div>
  66
  67
  68 <div class="para use">
  69 <h4>Example</h4>
  70 <pre>
  71     char str[12];
  72
  73     <span class="c">/* Get volume label of the default drive */</span>
  74     <em>f_getlabel</em>("", str, 0);
  75
  76     <span class="c">/* Get volume label of the drive 2 */</span>
  77     <em>f_getlabel</em>("2:", str, 0);
  78 </pre>
  79 </div>
  80
  81
  82 <div class="para ref">
  83 <h4>See Also</h4>
  84 <tt><a href="setlabel.html">f_setlabel</a></tt>
  85 </div>
  86
  87
  88 <p class="foot"><a href="../00index_e.html">Return</a></p>
  89 </body>
  90 </html>