Core Function FileAppend - Revision history

UberFoX: 1 revision

2015-06-14T12:38:07Z

1 revision

← Older revision

Revision as of 12:38, 14 June 2015

UberFoX: 1 revision

2014-08-11T21:40:29Z

1 revision

← Older revision

Revision as of 21:40, 11 August 2014

UberFoX at 16:26, 14 September 2013

2013-09-14T16:26:41Z

← Older revision		Revision as of 16:26, 14 September 2013
Line 1:		Line 1:
	<pre>		<pre>
−	FileAppend( <file>, <expression> )	+	FileAppend( <file>, <expression>, <useAscii> )
	</pre>		</pre>

Line 16:		Line 16:

	Text to write to the end of the file OR an array $variable to write each element at the end of the file.		Text to write to the end of the file OR an array $variable to write each element at the end of the file.
		+
		+	==== useAscii ====
		+
		+	Optional: Flag to decide if ASCII encoding should be used
		+
		+	True = Save using ASCII encoding
		+
		+	False = Save using UNICODE encoding
		+
		+	Default: false (All strings in Sputnik are Unicode to save them to file you must specifically request ASCII encoding)

	=== Return Value ===		=== Return Value ===

UberFoX: /* Return Value */

2013-08-29T09:12:34Z

Return Value

← Older revision		Revision as of 09:12, 29 August 2013
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 ===

UberFoX: /* Example */

2011-11-19T14:37:57Z

Example

← Older revision		Revision as of 14:37, 19 November 2011
Line 31:		Line 31:
	<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" );
Line 49:		Line 49:

	$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" );

UberFoX: /* Example */

2011-11-17T00:26:16Z

Example

← Older revision		Revision as of 00:26, 17 November 2011
Line 30:		Line 30:

	<syntaxhighlight lang="sputnik">		<syntaxhighlight lang="sputnik">
−	$File = FileOpen("MyFile.txt", "w")	+	$File = FileOpen("MyFile.txt", "w");
−	If isObj($File, "file") ~~Then ;~~ You could just use isObj($File) however adding the "file" will make sure it is indeed a file	+	If(isObj($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 1\n" );
−	FileAppend( $File, "This is line 3\n" )	+	FileAppend( $File, "This is line 2\n" );
−	FileClose( $File )	+	FileAppend( $File, "This is line 3\n" );
−	~~EndIf~~	+	FileClose( $File );
		+	}
	</syntaxhighlight>		</syntaxhighlight>

Line 42:		Line 43:

	<syntaxhighlight lang="sputnik">		<syntaxhighlight lang="sputnik">
−	$lines = array() ; Make a blank array	+	$lines = array(); // Make a blank array
−	$lines[0] = "This will be line 4\n"	+	$lines[0] = "This will be line 4\n";
−	$lines[1] = "This will be line 5\n"	+	$lines[1] = "This will be line 5\n";
−	$lines[2] = "This will be line 6\n"	+	$lines[2] = "This will be line 6\n";

−	$File = FileOpen("MyFile.txt", "w")	+	$File = FileOpen("MyFile.txt", "w");
−	If isObj($File, "file") ~~Then ;~~ You could just use isObj($File) however adding the "file" will make sure it is indeed a file	+	If(isObj($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 1\n" );
−	FileAppend( $File, "This is line 3\n" )	+	FileAppend( $File, "This is line 2\n" );
−	FileAppend( $File, $lines )	+	FileAppend( $File, "This is line 3\n" );
−	FileClose( $File )	+	FileAppend( $File, $lines );
−	~~EndIf~~	+	FileClose( $File );
		+	}
	</syntaxhighlight>		</syntaxhighlight>

	[[Category:Core Function]]		[[Category:Core Function]]

UberFoX: /* expression */

2011-11-10T07:27:49Z

expression

← Older revision		Revision as of 07:27, 10 November 2011
Line 15:		Line 15:
	==== expression ====		==== expression ====

−	Text to write to the end of the file.	+	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 ===		=== Return Value ===

UberFoX: /* Example */

2011-11-10T07:26:46Z

Example

← Older revision		Revision as of 07:26, 10 November 2011
Line 35:		Line 35:
	FileAppend( $File, "This is line 2\n" )		FileAppend( $File, "This is line 2\n" )
	FileAppend( $File, "This is line 3\n" )		FileAppend( $File, "This is line 3\n" )
−	~~FileSeek~~( $File, 0, "B" )	+	FileClose( $File )
−	~~FileWrite~~( $File, "~~Replace Line~~ 1" )	+	EndIf
		+	</syntaxhighlight>
		+
		+	Example of using an array with Append
		+
		+	<syntaxhighlight lang="sputnik">
		+	$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 isObj($File, "file") Then ; 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 )		FileClose( $File )
	EndIf		EndIf

UberFoX: Created page with "

 FileAppend( ,  )

=== Description === Append a line of text to the end of a previously opened text file. === Parameters === ==== file ==== A v..."

2011-11-09T09:59:44Z

Created page with "<pre> FileAppend( <file>, <expression> ) </pre> === Description === Append a line of text to the end of a previously opened text file. === Parameters === ==== file ==== A v..."

New page

<pre>
FileAppend( <file>, <expression> )
</pre>

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

=== Return Value ===

Success: Returns 1

Failure: Returns 0 if error occurs.

=== Remarks ===

This will always write to the end of the file.

=== Example ===

<syntaxhighlight lang="sputnik">
$File = FileOpen("MyFile.txt", "w")
If isObj($File, "file") Then ; 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" )
FileSeek( $File, 0, "B" )
FileWrite( $File, "Replace Line 1" )
FileClose( $File )
EndIf
</syntaxhighlight>

[[Category:Core Function]]