Core Function FileRead

From Sputnik Wiki
(Difference between revisions)
Jump to: navigation, search
(Created page with "<pre> FileRead( <file>, <expression> ) </pre> === Description === Read a number of characters from a previously opened text file starting from current File Steam pointer locati...")
 
(Example)
Line 32: Line 32:
  
 
<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"))
$Str = FileRead($File)
+
{
println( "String is: " . $Str )
+
$Str = FileRead($File);
FileClose( $File )
+
println( "String is: " . $Str );
EndIf
+
FileClose( $File );
 +
}
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 43: Line 44:
  
 
<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"))
FileSeek($File, 7, "b")
+
{
$Str = FileRead($File)
+
FileSeek($File, 7, "b");
println( "String is: " . $Str )
+
$Str = FileRead($File);
FileClose( $File )
+
println( "String is: " . $Str );
EndIf
+
FileClose( $File );
 +
}
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
[[Category:Core Function]]
 
[[Category:Core Function]]

Revision as of 00:22, 17 November 2011

FileRead( <file>, <expression> )

Contents

Description

Read a number of characters from a previously opened text file starting from current File Steam pointer location.

Parameters

file

A variable containing the File handle.

expression

Optional; Number of letters to read.

If this param is not provided it will read to the end of the file.

Return Value

Success: Returns a string

Failure: Returns 0 if error occurs.

Remarks

N/A

Example

$File = FileOpen("MyFile.txt", "r");
If(isObj($File, "file"))
{
	$Str = FileRead($File);
	println( "String is: " . $Str );
	FileClose( $File );
}

You could also tell it where to begin from example :

$File = FileOpen("MyFile.txt", "r");
If(isObj($File, "file"))
{
	FileSeek($File, 7, "b");
	$Str = FileRead($File);
	println( "String is: " . $Str );
	FileClose( $File );
}
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox