Fclose

fclose

Description:

Function fclose closes a file. Files should always be closed when the script no longer needs them (after reading/writing).

Using an invalid handle will crash your server! Get a valid handle by using fopen or ftemp.

This function name starts with a lowercase letter.

Parameters:

(File:handle)

int

handle

The file handle to close. Returned by fopen.

Return Values:

• 1: The function executed successfully.
• 0: The function failed to execute. The file could not be closed. It may already be closed.

Examples:

Example 1

// Open "file.txt" in "append only" mode
new File:handle = fopen("file.txt", io_append);
 
// Check, if file is open
if(handle)
{
	// Success
 
	// Write "Hi there!" into the file
	fwrite(handle, "Hi there!");
 
	// Close the file
	fclose(handle);
}
else
{
	// Error
	print("Failed to open file \"file.txt\".");
}

Related Functions

The following functions may be useful, as they are related to this function in one way or another.

• fopen: Open a file (to read from or write to).
• ftemp: Create a temporary file stream.
• fremove: Remove a file.
• fwrite: Write to a file.
• fread: Read a file.
• fputchar: Put a character in a file.
• fgetchar: Get a character from a file.
• fblockwrite: Write blocks of data into a file.
• fblockread: Read blocks of data from a file.
• fseek: Jump to a specific character in a file.
• flength: Get the file length.
• fexist: Check, if a file exists.
• fmatch: Check, if patterns with a file name matches.