Core Function FileRead

From Sputnik Wiki
(Difference between revisions)
Jump to: navigation, search
m (1 revision)
(expression)
Line 15: Line 15:
 
==== expression  ====
 
==== expression  ====
  
Optional; Number of letters to read.
+
Optional; Number of bytes to read.
  
 
If this param is not provided it will read to the end of the file.
 
If this param is not provided it will read to the end of the file.

Revision as of 07:19, 18 June 2015

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 bytes 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