Fclose

From SA-MP Wiki

Jump to: navigation, search

fclose

Image:Farm-Fresh text lowercase.png Note: This function name starts with a lowercase letter.


Description:

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


Parameters:
(File:handle)
File:handleThe 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.


Image:32px-Circle-style-warning.png

Warning

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


Example Usage:

// 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.


  • fclose: Close a file.
  • ftemp: Create a temporary file stream.
  • fgetchar: Get a character from a file.
  • fseek: Jump to a specific character in a file.
  • fexist: Check, if a file exists.
  • fmatch: Check, if patterns with a file name matches.
Personal tools
In other languages