Core Function FileReadLine

From Sputnik Wiki
(Difference between revisions)
Jump to: navigation, search
(Remarks)
(Example)
Line 30: Line 30:
  
 
<syntaxhighlight lang="sputnik">
 
<syntaxhighlight lang="sputnik">
$File = FileOpen("MyFile.txt", "r")
+
$File = FileOpen("MyFile.txt", "r");
If isObj($File, "file") Then
+
If(isObj($File, "file"))
$Line0 = FileReadLine($File, 0)
+
{
$Line1 = FileReadLine($File, 1)
+
$Line0 = FileReadLine($File, 0);
$Line2 = FileReadLine($File, 2)
+
$Line1 = FileReadLine($File, 1);
println( "Line0: " . $Line0 )
+
$Line2 = FileReadLine($File, 2);
println( "Line1: " . $Line1 )
+
println( "Line0: " . $Line0 );
println( "Line2: " . $Line2 )
+
println( "Line1: " . $Line1 );
FileClose( $File )
+
println( "Line2: " . $Line2 );
EndIf
+
FileClose( $File );
 +
}
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 45: Line 46:
  
 
<syntaxhighlight lang="sputnik">
 
<syntaxhighlight lang="sputnik">
$Line0 = FileReadLine("MyFile.txt", 0)
+
$Line0 = FileReadLine("MyFile.txt", 0);
$Line1 = FileReadLine("MyFile.txt", 1)
+
$Line1 = FileReadLine("MyFile.txt", 1);
$Line2 = FileReadLine("MyFile.txt", 2)
+
$Line2 = FileReadLine("MyFile.txt", 2);
println( "Line0: " . $Line0 )
+
println( "Line0: " . $Line0 );
println( "Line1: " . $Line1 )
+
println( "Line1: " . $Line1 );
println( "Line2: " . $Line2 )
+
println( "Line2: " . $Line2 );
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
[[Category:Core Function]]
 
[[Category:Core Function]]

Revision as of 00:21, 17 November 2011

FileReadLine( <file>, <expression> )

Contents

Description

Read a line of text from a previously opened text file (Or specify a name of a file).

Parameters

file

A variable containing the File handle OR a name of a file to open.

expression

Optional; Line number to read default is line 0 (0 means the first line).

Return Value

Success: Returns a string

Failure: Returns 0 if error occurs.

Remarks

Trailing newlines "\n" and "\r" will be removed from the end of the returned string automatically.

Example

$File = FileOpen("MyFile.txt", "r");
If(isObj($File, "file"))
{
	$Line0 = FileReadLine($File, 0);
	$Line1 = FileReadLine($File, 1);
	$Line2 = FileReadLine($File, 2);
	println( "Line0: " . $Line0 );
	println( "Line1: " . $Line1 );
	println( "Line2: " . $Line2 );
	FileClose( $File );
}

Heres an example of using it directly with a text file by name :

$Line0 = FileReadLine("MyFile.txt", 0);
$Line1 = FileReadLine("MyFile.txt", 1);
$Line2 = FileReadLine("MyFile.txt", 2);
println( "Line0: " . $Line0 );
println( "Line1: " . $Line1 );
println( "Line2: " . $Line2 );
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox