Core Function FileWrite

Latest revision as of 12:38, 14 June 2015

FileWrite( <file>, <expression>, <useAscii> ) 

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.

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

Success: Returns true

Failure: Returns false if error occurs.

Remarks

You can set the File Steam pointer location with 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 FileAppend( <file>, <expression> ) instead.

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" );
	FileSeek( $File, 0, "B" );
	FileWrite( $File, "Replace Line 1" );
	FileClose( $File );
}