System.Shell.Drive.totalFreeSpace Property

Article
03/12/2010

Gets the total amount of free space, in megabytes (MB), on the system storage device.

This property is read-only.

Syntax

propVal = System.Shell.Drive.totalFreeSpace()

Parameters

strFreeSpace [out]
Retrieves the total amount of free space.

Remarks

The value returned by totalFreeSpace is typically the same as freeSpace. Any difference between the properties occurs on computer systems that support enforced disk storage quotas, and can be due to user-privilege configurations assigned to the currently-logged-on user.

Examples

The following example demonstrates how to get the total free 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
Minimum supported server	Windows Server 2008
DLL	Sidebar.Exe version 1.00 or later