Fgets - Revision history

Sandman at 13:55, 26 June 2007

Sandman — Tue, 26 Jun 2007 13:55:59 GMT

←Older revision		Revision as of 13:55, 26 June 2007
Line 9:		Line 9:
	== Parameters ==		== Parameters ==
	{\|		{\|
-	\| '''INT''' filehandle \|\| - The [[FileHandle]] of the file returned by [[fopen]].	+	\| '''INT''' filehandle \|\| - The [[FileHandle]] of the file returned by [[fopen]]().
	\|}		\|}

Sandman at 13:28, 26 June 2007

Sandman — Tue, 26 Jun 2007 13:28:38 GMT

←Older revision		Revision as of 13:28, 26 June 2007
Line 9:		Line 9:
	== Parameters ==		== Parameters ==
	{\|		{\|
-	\| '''INT''' filehandle \|\| - The ~~handle~~ of the file returned by [[fopen]].	+	\| '''INT''' filehandle \|\| - The [[FileHandle]] of the file returned by [[fopen]].
	\|}		\|}

Sandman at 13:26, 26 June 2007

Sandman — Tue, 26 Jun 2007 13:26:35 GMT

←Older revision		Revision as of 13:26, 26 June 2007
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.

Sandman at 12:35, 26 June 2007

Sandman — Tue, 26 Jun 2007 12:35:06 GMT

←Older revision		Revision as of 12:35, 26 June 2007
Line 3:		Line 3:

	==Definition==		==Definition==
-	'''STRING''' ~~fgets~~ ( <'''~~INT~~''' ~~filehandle~~> )	+	'''STRING''' file ( <'''STRING''' filename> )

-	~~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~~.	+	Returns the whole contents of a certain file.

	== Parameters ==		== Parameters ==
	{\|		{\|
-	\| '''~~INT~~''' ~~filehandle~~ \|\| - The ~~handle~~ of the file ~~returned by [[fopen]]~~.	+	\| '''STRING''' filename \|\| - The filename of the file you wish to read from (including extension and possible path).
	\|}		\|}

	== Returns ==		== Returns ==
-	'''STRING''': The ~~line read.~~	+	'''STRING''': The contents of the file.
-		+
-	~~== 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~~.	+

Sandman at 12:27, 26 June 2007

Sandman — Tue, 26 Jun 2007 12:27:22 GMT

New page

[[Category:functions]]
[[Category:files]]

==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.