Core Function FileWrite - 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:43Z

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

Line 16:		Line 16:

	Text to write to file.		Text to write to 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 ===

−	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:38:09Z

Example

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

UberFoX: /* Example */

2011-11-17T00:24:46Z

Example

← Older revision		Revision as of 00:24, 17 November 2011
Line 32:		Line 32:

	<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" );
−	FileSeek( $File, 0, "B" )	+	FileAppend( $File, "This is line 3\n" );
−	FileWrite( $File, "Replace Line 1" )	+	FileSeek( $File, 0, "B" );
−	FileClose( $File )	+	FileWrite( $File, "Replace Line 1" );
−	~~EndIf~~	+	FileClose( $File );
		+	}
	</syntaxhighlight>		</syntaxhighlight>

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

UberFoX: /* Example */

2011-11-12T13:46:33Z

Example

← Older revision		Revision as of 13:46, 12 November 2011
Line 31:		Line 31:
	=== Example ===		=== Example ===

−	~~Example with a writing text :~~
	<syntaxhighlight lang="sputnik">		<syntaxhighlight lang="sputnik">
	$File = FileOpen("MyFile.txt", "w")		$File = FileOpen("MyFile.txt", "w")

UberFoX at 13:43, 12 November 2011

2011-11-12T13:43:32Z

← Older revision		Revision as of 13:43, 12 November 2011
Line 5:		Line 5:
	=== Description ===		=== Description ===

−	Write text~~/binary~~ to previously opened file at the current File Steam pointer location.	+	Write text to previously opened text file at the current File Steam pointer location.

	=== Parameters ===		=== Parameters ===
Line 16:		Line 16:

	Text to write to file.		Text to write to file.
−
−	OR
−
−	~~A binary variable to write to the file.~~

	=== Return Value ===		=== Return Value ===
Line 44:		Line 40:
	FileSeek( $File, 0, "B" )		FileSeek( $File, 0, "B" )
	FileWrite( $File, "Replace Line 1" )		FileWrite( $File, "Replace Line 1" )
−	~~FileClose( $File )~~
−	~~EndIf~~
−	~~</syntaxhighlight>~~
−
−	~~Example with a writing binary :~~
−
−	~~<syntaxhighlight lang="sputnik">~~
−	~~$binary = Pack("z0", "Hello World!")~~
−	~~$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~~
−	~~FileWrite( $File, $binary )~~
	FileClose( $File )		FileClose( $File )
	EndIf		EndIf

UberFoX at 13:42, 12 November 2011

2011-11-12T13:42:04Z

← Older revision		Revision as of 13:42, 12 November 2011
Line 5:		Line 5:
	=== Description ===		=== Description ===

−	Write text to previously opened ~~text~~ file at the current File Steam pointer location.	+	Write text/binary to previously opened file at the current File Steam pointer location.

	=== Parameters ===		=== Parameters ===
Line 16:		Line 16:

	Text to write to file.		Text to write to file.
		+
		+	OR
		+
		+	A binary variable to write to the file.

	=== Return Value ===		=== Return Value ===
Line 31:		Line 35:
	=== Example ===		=== Example ===

		+	Example with a writing text :
	<syntaxhighlight lang="sputnik">		<syntaxhighlight lang="sputnik">
	$File = FileOpen("MyFile.txt", "w")		$File = FileOpen("MyFile.txt", "w")
Line 39:		Line 44:
	FileSeek( $File, 0, "B" )		FileSeek( $File, 0, "B" )
	FileWrite( $File, "Replace Line 1" )		FileWrite( $File, "Replace Line 1" )
		+	FileClose( $File )
		+	EndIf
		+	</syntaxhighlight>
		+
		+	Example with a writing binary :
		+
		+	<syntaxhighlight lang="sputnik">
		+	$binary = Pack("z0", "Hello World!")
		+	$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
		+	FileWrite( $File, $binary )
	FileClose( $File )		FileClose( $File )
	EndIf		EndIf

UberFoX: /* Remarks */

2011-11-09T09:58:48Z

Remarks

← Older revision		Revision as of 09:58, 9 November 2011
Line 26:		Line 26:

	You can set the File Steam pointer location with [[Core Function FileSeek\|FileSeek( <file>, <offset>, <flag> )]].		You can set the File Steam pointer location with [[Core Function FileSeek\|FileSeek( <file>, <offset>, <flag> )]].
		+
		+	Warning this will not write to the end of the file unless you tell it to with seek so if you want to write to end of the file you should use [[Core Function FileAppend\|FileAppend( <file>, <expression> )]] instead.

	=== Example ===		=== Example ===

UberFoX: Created page with "

 FileWrite( ,  )

=== Description === Write text to previously opened text file at the current File Steam pointer location. === Parameters === =..."

2011-11-09T09:57:39Z

Created page with "<pre> FileWrite( <file>, <expression> ) </pre> === Description === Write text to previously opened text file at the current File Steam pointer location. === Parameters === =..."

New page

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

=== Description ===

Write text to previously opened text file at the current File Steam pointer location.

=== Parameters ===

==== file ====

A variable containing the File handle.

==== expression ====

Text to write to file.

=== Return Value ===

Success: Returns 1

Failure: Returns 0 if error occurs.

=== Remarks ===

You can set the File Steam pointer location with [[Core Function FileSeek|FileSeek( <file>, <offset>, <flag> )]].

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