Core Function FileClose

From Sputnik Wiki
(Difference between revisions)
Jump to: navigation, search
(Example)
m (1 revision)
 
(3 intermediate revisions by one user not shown)
Line 15: Line 15:
 
=== Return Value ===
 
=== Return Value ===
  
Success: Returns 1
+
Success: Returns true
  
Failure: Returns 0 if error occurs.
+
Failure: Returns false if error occurs.
  
 
=== Remarks ===
 
=== Remarks ===
Line 27: Line 27:
 
<syntaxhighlight lang="sputnik">
 
<syntaxhighlight lang="sputnik">
 
$File = FileOpen("MyFile.txt", "w");
 
$File = FileOpen("MyFile.txt", "w");
If(isObj($File, "file")) // You could just use isObj($File) however adding the "file" will make sure it is indeed a file
+
If(isVarObj($File, "file")) // You could just use isObj($File) however adding the "file" will make sure it is indeed a file
 
{
 
{
 
FileAppend( $File, "This is line 1\n" );
 
FileAppend( $File, "This is line 1\n" );

Latest revision as of 12:38, 14 June 2015

FileClose( <file> )

Contents

Description

Closes a previously opened text file.

Parameters

file

A variable containing the File handle.

Return Value

Success: Returns true

Failure: Returns false if error occurs.

Remarks

N/A

Example

$File = FileOpen("MyFile.txt", "w");
If(isVarObj($File, "file")) // You could just use isObj($File) however adding the "file" will make sure it is indeed a file
{
	FileAppend( $File, "This is line 1\n" );
	FileAppend( $File, "This is line 2\n" );
	FileAppend( $File, "This is line 3\n" );
	FileClose( $File );
}
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox