Core Function FileWriteLines - Revision history

UberFoX: /* Example */

2015-06-18T10:37:28Z

Example

← Older revision		Revision as of 10:37, 18 June 2015
Line 69:		Line 69:
	FileWrite( $File, "Test\n" );		FileWrite( $File, "Test\n" );
	FileWrite( $File, "Test2\n" );		FileWrite( $File, "Test2\n" );
−	FileWriteLines( $File, array("One", "Two", "Three", "Four"), "~~<~~br~~>~~" );	+	FileWriteLines( $File, array("One", "Two", "Three", "Four"), "<br>" );
	FileClose( $File );		FileClose( $File );
	}		}

UberFoX: /* Example */

2015-06-18T10:37:16Z

Example

← Older revision		Revision as of 10:37, 18 June 2015
Line 61:		Line 61:
	</syntaxhighlight>		</syntaxhighlight>

−	Lets use "<br>" for the line breaks	+	Lets use "<br>" for the line breaks

	<syntaxhighlight lang="sputnik">		<syntaxhighlight lang="sputnik">
Line 69:		Line 69:
	FileWrite( $File, "Test\n" );		FileWrite( $File, "Test\n" );
	FileWrite( $File, "Test2\n" );		FileWrite( $File, "Test2\n" );
−	FileWriteLines( $File, array("One", "Two", "Three", "Four"), "<br>" );	+	FileWriteLines( $File, array("One", "Two", "Three", "Four"), "<br>" );
	FileClose( $File );		FileClose( $File );
	}		}

UberFoX: Created page with "

 FileWriteLines( , , ,  )

=== Description === Write an array of lines to previously opened file at the current File Steam pointer ..."

2015-06-18T10:30:37Z

Created page with "<pre> FileWriteLines( <file>, <array>, <lineBreak>, <useAscii> ) </pre> === Description === Write an array of lines to previously opened file at the current File Steam pointer ..."

New page

<pre>
FileWriteLines( <file>, <array>, <lineBreak>, <useAscii> )
</pre>

=== Description ===

Write an array of lines to previously opened file at the current File Steam pointer location.

=== Parameters ===

==== file ====

A variable containing the File handle.

==== array ====

The array to write to the file.

Each element in the array will be considered a new line for the file.

==== lineBreak ====

Optional; The line break to use.

Default: "\n"

==== 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 [[Core Function FileSeek|FileSeek( )]].

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 FileAppendLines|FileAppendLines( )]] instead.

=== Example ===

<syntaxhighlight lang="sputnik">
$File = FileOpen("a.txt", "w");
If(isVarObj($File, "file"))
{
FileWrite( $File, "Test\n" );
FileWrite( $File, "Test2\n" );
FileWriteLines( $File, array("One", "Two", "Three", "Four") );
FileClose( $File );
}

</syntaxhighlight>

Lets use "<br>" for the line breaks

<syntaxhighlight lang="sputnik">
$File = FileOpen("a.txt", "w");
If(isVarObj($File, "file"))
{
FileWrite( $File, "Test\n" );
FileWrite( $File, "Test2\n" );
FileWriteLines( $File, array("One", "Two", "Three", "Four"), "<br>" );
FileClose( $File );
}
</syntaxhighlight>

[[Category:Core Function]]