f_getlabel
-
The f_getlabel function returns volume label and volume serial number of a drive.
+
The f_getlabel function returns volume label and volume serial number of a volume.
FRESULT f_getlabel (
const TCHAR* path, /* [IN] Drive number */
@@ -29,7 +29,15 @@ FRESULT f_getlabel (
path
Pointer to the null-terminated string that specifies the logical drive. Null-string specifies the default drive.
label
-
Pointer to the buffer to store the volume label. The buffer size must be at least 24 items at _LFN_UNICODE == 0 or 12 items at _LFN_UNICODE == 1. If the volume has no label, a null-string will be returned. Set null pointer if this information is not needed.
+
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.
+
+| Configuration | FF_FS_EXFAT == 0 | FF_FS_EXFAT == 1 |
+| FF_USE_LFN == 0 | 12 items | - |
+| FF_LFN_UNICODE == 0 | 12 items | 23 items |
+| FF_LFN_UNICODE == 1/3 | 12 items | 12 items |
+| FF_LFN_UNICODE == 2 | 34 items | 34 items |
+
+
vsn
Pointer to the DWORD variable to store the volume serial number. Set null pointer if this information is not needed.
@@ -53,20 +61,20 @@ FRESULT f_getlabel (
QuickInfo
-
Available when _USE_LABEL == 1.
+
Available when FF_USE_LABEL == 1.
Example
- char str[24];
+ char str[12];
/* Get volume label of the default drive */
- f_getlabel("", str, 0);
+ f_getlabel("", str, 0);
/* Get volume label of the drive 2 */
- f_getlabel("2:", str, 0);
+ f_getlabel("2:", str, 0);