note Help Needed

This wiki is the result of an ongoing community effort — thank you all for helping!

If you want to provide changes to this page then please click here.

fclose

warning

This function starts with a lowercase letter.

Description

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

Name	Description
File:handle	The file handle to close. Returned by fopen.

Returns

true - The function executed successfully.

false - The function failed to execute. The file could not be closed. It may already be closed.

Examples

// 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\".");
}

Notes

warning

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

Related Functions

fopen: Open a file.
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.
ftell: Get the current position in the file.
fflush: Flush a file to disk (ensure all writes are complete).
fstat: Return the size and the timestamp of a file.
frename: Rename a file.
fcopy: Copy a file.
filecrc: Return the 32-bit CRC value of a file.
diskfree: Returns the free disk space.
fattrib: Set the file attributes.
fcreatedir: Create a directory.