User Guide Cancel

GetFreeSpace

 

Description

Gets information about free hard disk space or free in-memory VFS space.

Returns

Returns the free space in bytes.

Syntax

getFreeSpace(path)

Parameters

Parameter

Description

path

Path to the

  • Hard disk drive, for example C: }}for Windows or {{/ for UNIX. Note that for Windows, you have to explicitly use colon (:) and not just C. Only the space of the entire hard disk drive is returned. If you mention a directory in the path, for example, /opt/, it is ignored and only {{/ }}is considered.
  • For in-memory file system, the path is ram:.

Usage

See the usage section for GetTotalSpace.

Example

In the following example, in-memory file system memory for the application is set to 20 MB in ColdFusion Administrator. The function returns 20, which means the total space considered is 20 MB. This is because the value specified in the ColdFusion Administrator (Memory Limit per Application for In-Memory Virtual File System) is lesser than the value specified in the Application.cfc (20 MB).Application.cfc

<cfcomponent>
<cfset this.name = "vfs_total_space">
<cfset this.inmemoryfilesystem.size = 30>
</cfcomponent>

space.cfm

<cftry>
<cfset totalRAMSpace = getTotalSpace("ram:")>
<cfset freeRAMSpace = getFreeSpace("ram:")>
<cfset totalDiskSpace = getTotalSpace("c:")>
<cfset freeDiskSpace = getFreeSpace("c:")>
<cfoutput>
Total Hard Disk Space = #DecimalFormat(totalDiskSpace / (1024 * 1024 * 1024))# GB
<br>Free Hard Disk Space = #DecimalFormat(freeDiskSpace / (1024 * 1024 * 1024))# GB
<br>Total Application RAM Memory = #DecimalFormat(totalRAMSpace / (1024 * 1024))# MB
<br>Free Application RAM Memory = #DecimalFormat(freeRAMSpace / (1024 * 1024))# MB
<br>
</cfoutput>
<cfcatch type="any">
<cfoutput>
#cfcatch.message#
<br>#cfcatch.detail#
<br>
</cfoutput>
</cfcatch>
</cftry>

 

Get help faster and easier

New user?