System.Shell.Drive.volumeLabel property
[ The Windows Gadget Platform/Sidebar is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. ]
Gets or sets the volume label of the system storage device.
This property is read/write.
Syntax
strvolumeLabel = System.Shell.Drive.volumeLabel
System.Shell.Drive.volumeLabel = strvolumeLabel
Property value
A String that specifies or receives the volume label.
Remarks
Administrator privileges are required to change the volume label.
This value is not guaranteed to be unique unless it is used with a drive letter identifier.
The label length is determined by the operating system. For example, NTFS allows a volume label to be up to 32 characters long. Note that null is a valid volume label.
Examples
The following example demonstrates how to get the total space of a storage device.
// --------------------------------------------------------------------
// Display drive information.
// driveLetter: user input.
// --------------------------------------------------------------------
function GetDriveInfo(driveLetter)
{
var sDrive = "";
var drive = System.Shell.drive(driveLetter);
if (drive)
{
if (drive.isReady)
{
sDrive = "Label:" + drive.volumeLabel + " for drive(" + drive.driveLetter + ")<br/>";
sDrive += "FreeSpace: " + drive.freeSpace + "MB<br/>";
sDrive += "TotalFreeSpace: " + drive.totalFreeSpace + "MB<br/>";
sDrive += "TotalSpace: " + drive.totalSize + "MB<br/>";
sDrive += "DriveType: " + drive.driveType + "<br/>";
sDrive += "DriveFormat: " + drive.driveFormat + "<br/>";
sDrive += "RootDir: [" + drive.rootDirectory + "]<br/>";
}
else
{
sDrive = "Drive (" + driveLetter + ") is not ready.<br/>";
}
}
else
{
sDrive = "Drive (" + driveLetter + ") is not valid.<br/>";
}
spFeedback.innerHTML = sDrive;
}
Requirements
| Minimum supported client |
Windows Vista [desktop apps only] |
| Minimum supported server |
Windows Server 2008 [desktop apps only] |
| End of client support |
Windows 7 |
| End of server support |
Windows Server 2008 |
| IDL |
|
| DLL |
|