====== fclose ======

===== Description =====

Close a file handle.

===== Function prototype =====

<code>
bool fclose <voidptr:hFile>
</code>

===== Arguments =====

^ Name ^ Type ^ Comment ^
| hFile | voidptr | A handle to a file that was previously opened by [[plugins:general:zeoscript:reference:functions:fopen]] or [[plugins:general:zeoscript:reference:functions:fopen_s]]. |

===== Return value =====

False if:
  * The file handle is invalid, or;
  * The file handle cannot be closed.
True otherwise.

===== Example =====

<code>
voidptr fp // create a file handle
set fp <zs:fopen "C:\\test.txt" "w"> // open the file, and assign the value to 'fp'
assert fp "Cannot open file!" // exit if file can't be opened

string s
set string "Hello!"
fwrite fp s // write text to file

fclose fp // close file
</code>

===== Comments =====

None.


===== See also =====

  * [[plugins:general:zeoscript:reference:functions:fopen]]
  * [[plugins:general:zeoscript:reference:functions:fopen_s]]
  * [[plugins:general:zeoscript:reference:functions:fread]]
  * [[plugins:general:zeoscript:reference:functions:fwrite]]
  * [[plugins:general:zeoscript:reference:functions:fgetc]]
  * [[plugins:general:zeoscript:reference:functions:fputc]]
  * [[plugins:general:zeoscript:reference:functions:fseek]]
  * [[plugins:general:zeoscript:reference:functions:ftell]]
  * [[plugins:general:zeoscript:reference:functions:rewind]]