FileDelete

Description

Deletes the specified on-disk or in-memory file on the server.

Category

System functions

Function syntax

FileDelete(filepath)

See also

FileClose, FileIsEOF, FileOpen, FileRead, FileReadLine, FileWrite, cffile

History

ColdFusion 8: Added this function.

Parameters

Parameter

Description

filepath

Pathname of the on-disk or in-memory file to delete. If not an absolute path (starting with a drive letter and a colon, or a forward or backward slash), it is relative to the ColdFusion temporary directory, which is returned by the GetTempDirectory function.

Usage

Use this function to free the memory used by an in-memory file. For more information on using in-memory files, see Working with in-memory files in the Developing ColdFusion Applications.

Example

The following example deletes the file c:\productiondir\test1.txt before moving c:\testdir\test1.txt:

<h3>FileDelete Example</h3> 
 
<cfset sourcefile="c:\testdir\test1.txt"> 
<cfset destinationfile="c:\productiondir\test1.txt"> 
 
<cfif FileExists(#sourcefile#)> 
    <cfif FileExists(#destinationfile#)> 
        <cfoutput>The destination file already exists.<br> 
            Deleting previous copy of #destinationfile#.<br> 
            Moving: #sourcefile# <br> 
            To: <br> #destinationfile#.</cfoutput><br> 
        <cfscript> 
            FileDelete(#destinationfile#); 
            FileMove(#sourcefile#, #destinationfile#); 
        </cfscript> 
    <cfelse> 
        <cfscript> 
            FileMove(#sourcefile#, #destinationfile#); 
        </cfscript> 
        <cfoutput>Moved: #sourcefile# <br> 
            To: <br> #destinationfile#.</cfoutput><br> 
    </cfif> 
<cfelse> 
    <cfoutput>The source file does not exist.</cfoutput><br> 
</cfif>