fclose

Tags:

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

1: The function executed successfully.

0: 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.

  • fopen: Open a file.
  • fclose: Close 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.