This wiki is out of date, use the continuation of this wiki instead

From FenixWiki

Revision as of 12:35, 26 June 2007 (edit) Sandman (Talk | contribs) ← Previous diff		Revision as of 13:26, 26 June 2007 (edit) (undo) Sandman (Talk | contribs) Next diff →
Line 3:		Line 3:
	==Definition==		==Definition==
-	'''STRING''' file ( <'''STRING''' filename> )	+	'''STRING''' fgets ( <'''INT''' filehandle> )
-	Returns the whole contents of a certain file.	+	Reads a line from a certain file and returns it. Subsequent calls will return the next line, until the end of the file is reached.
	== Parameters ==		== Parameters ==
	{|		{|
-	| '''STRING''' filename || - The filename of the file you wish to read from (including extension and possible path).	+	| '''INT''' filehandle || - The handle of the file returned by [[fopen]].
	|}		|}
	== Returns ==		== Returns ==
-	'''STRING''': The contents of the file.	+	'''STRING''': The line read.
		+
		+	== Notes ==
		+	The returned string normally does not contain the '\n' or '\r','\n' charactersets.
		+
		+	When a line ends with the character '\', the next line will be joined with the current one, changing the '\' character to a '\n' character.

---

Revision as of 13:26, 26 June 2007

Contents 1 Definition 2 Parameters 3 Returns 4 Notes

Definition

STRING fgets ( <INT filehandle> )

Reads a line from a certain file and returns it. Subsequent calls will return the next line, until the end of the file is reached.

Parameters

INT filehandle

- The handle of the file returned by fopen.

Returns

STRING: The line read.

Notes

The returned string normally does not contain the '\n' or '\r','\n' charactersets.

When a line ends with the character '\', the next line will be joined with the current one, changing the '\' character to a '\n' character.