SetVolumeLabel

The SetVolumeLabel function sets the label of a file system volume.

BOOL SetVolumeLabel(
  LPCTSTR lpRootPathName,  // name of volume root directory 
  LPCTSTR lpVolumeName     // name for the volume
);

Parameters

lpRootPathName

[in] Pointer to a null-terminated string specifying the root directory of a file system volume. This is the volume the function will label. A trailing backslash is required. If this parameter is NULL, the root of the current directory is used.

lpVolumeName

[in] Pointer to a string specifying a name for the volume. If this parameter is NULL, the function deletes the label from the specified volume.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Requirements

  Windows NT/2000: Requires Windows NT 3.1 or later.
  Windows 95/98: Requires Windows 95 or later.
  Header: Declared in Winbase.h; include Windows.h.
  Library: Use Kernel32.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT/2000.

See Also

File I/O Overview, File I/O Functions, GetVolumeInformation