FileClose

Description

Closes an on-disk or in-memory file that is open. When you use the FileOpen function, ColdFusion returns a handle to a file object.When you close the file, the handle is still available; however, it lists the file as closed.

Category

System functions

Function syntax

FileClose(fileObj)

See also

FileCopy, FileIsEOF, FileOpen, FileRead, FileReadLine, FileWrite

History

ColdFusion 8: Added this function.

Parameters

Usage

Always close a file after opening it. When you use the FileOpen function to open a file, the file stream is opened and contents are read from or written to it. The FileClose function closes the stream. If you do not close a file, the stream remains open; in that case, the operating system can lock the file, which results in the file not being usable until the server is restarted.

Example

The following example checks to see if a file is still open and closes it.

<cfscript>  
myfile = FileOpen("c:\ColdFusion9\wwwroot\test1.txt", "read"); 
while(NOT FileIsEOF(myfile)) 
{ 
x = FileReadLine(myfile); 
WriteOutput("#x# <br>"); 
} 
</cfscript> 
<!--- Additional code goes here. ---> 
<cfif #myfile.status# IS "open"> 
    <cfoutput>The file #myfile.filepath# is #myfile.status#</cfoutput><br> 
    <cfscript>  
    FileClose(myfile); 
    </cfscript> 
</cfif>