Windows API Guide - Reference - Volume 1: Version 3.0 For the MS-DOS and PC-DOS Operating Systems

2017-07-07 02:10:07

Declare Function SetVolumeLabel Lib "kernel32.dll" Alias "SetVolumeLabelA" (ByVal lpRootPathName As String, ByVal lpVolumeName As String) As Long

Platforms

Windows 95: Supported.
Windows 98: Supported.
Windows NT: Requires Windows NT 3.1 or later.
Windows 2000: Supported.
Windows CE: Not Supported.

Description & Usage

SetVolumeLabel sets the label of a file system volume. The new volume label must comply with length constaints and cannot contain any invalid characters.

Return Value

If an error occured, the function returns 0 (use GetLastError to get the error code). If successful, the function returns a non-zero value.

Visual Basic-Specific Issues

None.

Parameters

lpRootPathName: The path of the root directory of the drive to set the file system volume label of. This path must include the trailing backslash. For example, the C: drive would be "C:\".
lpVolumeName: The new name to assign to the volume.

Example

' This code is licensed according to the terms and conditions listed here. ' Declarations and such needed for the example: ' (Copy these to the (declarations) section of a module.) Public Declare Function SetVolumeLabel Lib "kernel32.dll" Alias "SetVolumeLabelA" _ (ByVal lpRootPathName As String, ByVal lpVolumeName As String) As Long ' Set the file system volume label of the C: drive to "MYDRIVE". Dim retval As Long ' return value ' Set the new volume label. retval = SetVolumeLabel("C:\", "MYDRIVE")