Core Function FileRead

From Sputnik Wiki
(Difference between revisions)
Jump to: navigation, search
(Example)
(Return Value)
Line 23: Line 23:
 
Success: Returns a string
 
Success: Returns a string
  
Failure: Returns 0 if error occurs.
+
Failure: Returns null if error occurs.
  
 
=== Remarks ===
 
=== Remarks ===

Revision as of 11:20, 29 August 2013

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 null if error occurs.

Remarks

N/A

Example

$File = FileOpen("MyFile.txt", "r");
If(isVarObj($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(isVarObj($File, "file"))
{
	FileSeek($File, 7, "b");
	$Str = FileRead($File);
	println( "String is: " . $Str );
	FileClose( $File );
}
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox