File | Called from | Code enabled by |
---|---|---|
| Application | not |
Set volume label.
Arguments
name_vol
Volume name.
label
Volume label.
p_err
Pointer to variable that will receive the return error code from this function:
FS_ERR_NONE
Label set.
FS_ERR_DEV_CHNGD
Device has changed.
FS_ERR_NAME_NULL
Argument name_vol
passed a NULL pointer.
FS_ERR_NULL_PTR
Argument label passed a NULL pointer.
FS_ERR_DEV
Device access error.
FS_ERR_DIR_FULL
Directory is full (space could not be allocated).
FS_ERR_DEV_FULL
Device is full (space could not be allocated).
FS_ERR_VOL_LABEL_INVALID
Volume label is invalid.
FS_ERR_VOL_LABEL_TOO_LONG
Volume label is too long.
FS_ERR_VOL_NOT_MOUNTED
Volume is not mounted.
FS_ERR_VOL_NOT_OPEN
Volume is not open.
Returned Value
None.
Notes/Warnings
- The label on a FAT volume must be no longer than 11-characters, each belonging to the set of valid short file name (SFN) characters. Before it is committed to the volume, the label will be converted to upper case and will be padded with spaces until it is an 11-character string.