FSVol_LabelGet()

void  FSVol_LabelGet (CPU_CHAR    *name_vol,

                      CPU_CHAR    *label,

                      CPU_SIZE_T   len_max,

                      FS_ERR      *p_err);

Get volume label.

Arguments

name_vol

Volume name.

label

String buffer that will receive volume label.

len_max

Size of string buffer.

p_err

Pointer to variable that will receive the return error code from this function:

FS_ERR_NONE

Label gotten.

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_VOL_LABEL_NOT_FOUND

Volume label was not found.

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.

Required Configuration

None.

Notes/Warnings

len_max is the maximum length string that can be stored in the buffer label; it does not include the final NULL character. The buffer label must be of at least len_max + 1 characters.