Core Function FileAppend

From Sputnik Wiki
(Difference between revisions)
Jump to: navigation, search
(Example)
(Return Value)
Line 19: Line 19:
 
=== Return Value ===
 
=== Return Value ===
  
Success: Returns 1
+
Success: Returns true
  
Failure: Returns 0 if error occurs.
+
Failure: Returns false if error occurs.
  
 
=== Remarks ===
 
=== Remarks ===

Revision as of 09:12, 29 August 2013

FileAppend( <file>, <expression> )

Contents

Description

Append a line of text to the end of a previously opened text file.

Parameters

file

A variable containing the File handle.

expression

Text to write to the end of the file OR an array $variable to write each element at the end of the file.

Return Value

Success: Returns true

Failure: Returns false if error occurs.

Remarks

This will always write to the end of the file.

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 );
}

Example of using an array with Append

$lines = array(); // Make a blank array
$lines[0] = "This will be line 4\n";
$lines[1] = "This will be line 5\n";
$lines[2] = "This will be line 6\n";
 
$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" );
	FileAppend( $File, $lines );
	FileClose( $File );
}
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox