Search
Module:
Directory

   Desktop Functions:

   Smart Device Functions:


Show Recent Changes
Subscribe (RSS)
Misc. Pages
Comments
FAQ
Helpful Tools
Playground
Suggested Reading
Website TODO List
Support Forum
Download Visual Studio Add-In

Terms of Use
Privacy Policy
GetDiskFreeSpaceEx (kernel32)
 
.
Summary
Retrieves information about the amount of space available on a disk volume.

C# Signature:

[DllImport("kernel32.dll", SetLastError=true, CharSet=CharSet.Auto)]
[return: MarshalAs(UnmanagedType.Bool)]
   static extern bool GetDiskFreeSpaceEx(string lpDirectoryName,
   out ulong lpFreeBytesAvailable,
   out ulong lpTotalNumberOfBytes,
   out ulong lpTotalNumberOfFreeBytes);

User-Defined Types:

None.

Notes:

None.

Tips & Tricks:

None.

Sample Code:

ulong FreeBytesAvailable;
ulong TotalNumberOfBytes;
ulong TotalNumberOfFreeBytes;

bool success = GetDiskFreeSpaceEx("C:\\", out FreeBytesAvailable, out TotalNumberOfBytes,
                   out TotalNumberOfFreeBytes);
if (!success)
    throw new System.ComponentModel.Win32Exception();

Console.WriteLine("Free Bytes Available:      {0,15:D}", FreeBytesAvailable);
Console.WriteLine("Total Number Of Bytes:     {0,15:D}", TotalNumberOfBytes);
Console.WriteLine("Total Number Of FreeBytes: {0,15:D}", TotalNumberOfFreeBytes);

Alternative Managed API:

Starting in v2.0 (Whidbey) of the .NET Framework, this is exposed through the System.Io.DriveInfo class.

Unfortunately DriveInfo is not working for UNC Paths, for them you still have to use the above function

Windows CE:

The call is also available via coredll.dll on CE devices:

[DllImport("coredll.dll", SetLastError=true, CharSet=CharSet.Auto)]
[return: MarshalAs(UnmanagedType.Bool)]
   static extern bool GetDiskFreeSpaceEx(string lpDirectoryName,
   out ulong lpFreeBytesAvailable,
   out ulong lpTotalNumberOfBytes,
   out ulong lpTotalNumberOfFreeBytes);

Documentation

Here is a C# wrapper for the call

/// <summary>
/// Determines the ammount of free space on a drive (local or remote) in bytes
/// </summary>
/// <param name="folderName">Directory or unc folder name of the volume to
/// be checked (can be a networked drive)</param>
/// <param name="freespace">Ammount of freespace is returned here in bytes, 0
/// if the value could not be obtained</param>
/// <returns>true if the method successfully retrieved the ammount of freespace
/// on the given drive, false  otherwise</returns>
public static bool DriveFreeBytes(string folderName, out long freespace)
{
   freespace = 0;
   if (string.IsNullOrEmpty(folderName))
   {
     throw new ArgumentNullException("folderName");
   }

   if (!folderName.EndsWith("\\"))
   {
     folderName += '\\';
   }

   long free = 0, dummy1 = 0, dummy2 = 0;

   if (GetDiskFreeSpaceEx(folderName, ref free, ref dummy1, ref dummy2))
   {
     freespace = free;
     return true;
   }
   else
   {
     return false;
   }
}

Please edit this page!

Do you have...

  • helpful tips or sample code to share for using this API in managed code?
  • corrections to the existing content?
  • variations of the signature you want to share?
  • additional languages you want to include?

Select "Edit This Page" on the right hand toolbar and edit it! Or add new pages containing supporting types needed for this API (structures, delegates, and more).

 
Access PInvoke.net directly from VS:
Terms of Use
Edit This Page
Find References
Show Printable Version
Revisions