From 20236a8a990cae729bca1f7a4e0d619e92a5e37d Mon Sep 17 00:00:00 2001 From: Damien George Date: Sat, 20 Dec 2014 21:15:16 +0000 Subject: stmhal: Upgrade to latest fatfs driver. --- stmhal/fatfs/doc/en/setlabel.html | 89 --------------------------------------- 1 file changed, 89 deletions(-) delete mode 100644 stmhal/fatfs/doc/en/setlabel.html (limited to 'stmhal/fatfs/doc/en/setlabel.html') diff --git a/stmhal/fatfs/doc/en/setlabel.html b/stmhal/fatfs/doc/en/setlabel.html deleted file mode 100644 index f689717bb..000000000 --- a/stmhal/fatfs/doc/en/setlabel.html +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - -FatFs - f_setlabel - - - - -
-

f_setlabel

-

The f_setlabel function sets/removes the label of a volume.

-
-FRESULT f_setlabel (
-  const TCHAR* name  /* [IN] Volume label to be set */
-);
-
-
- -
-

Parameters

-
-
name
-
Pointer to the null-terminated string that specifies the volume label to be set.
-
-
- - -
-

Return Values

-

-FR_OK, -FR_DISK_ERR, -FR_INT_ERR, -FR_NOT_READY, -FR_INVALID_NAME, -FR_WRITE_PROTECTED, -FR_INVALID_DRIVE, -FR_NOT_ENABLED, -FR_NO_FILESYSTEM, -FR_TIMEOUT -

-
- - -
-

Description

-

When the string has a drive number, the volume label will be set to the volume specified by the drive number. If the volume label is a null-string, the volume label on the volume will be removed. The format of the volume label is similar to the SFN but there are some differences shown below:

- -
- -
-

QuickInfo

-

Available when _FS_READONLY == 0 and _USE_LABEL == 1.

-
- - -
-

Example

-
-    /* Set volume label to the default drive */
-    f_setlabel("DATA DISK");
-
-    /* Set volume label to the drive 2 */
-    f_setlabel("2:DISK 3 OF 4");
-
-    /* Remove volume label of the drive 2 */
-    f_setlabel("2:");
-
-
- - -
-

See Also

-f_getlabel -
- - -

Return

- - -- cgit v1.2.3