_release/help/commands/2d_commands/ReadFile.htm

<html>
<head>
<title>Blitz3D Docs</title>
<link rel=stylesheet href=../css/commands.css type=text/css>
</head>
<body>
<h1>ReadFile (filename$)</h1>
<h1>Parameters</h1>
<table>
<tr>
<td>
filename$ = any valid path and filename. The returned value is the filehandle  which is an integer value.
</td>
</tr>
</table>
<h1>Description</h1>
<table>
<tr>
<td>
This command opens the designated filename and prepares it to be read from.  Use this to read back your own configuration file, save game data, etc. also  useful for reading custom types from a files. The filehandle that is returned  is an integer value that the operating system uses to identify which file is  to be read from and must be passed to the functions such as ReadInt(). If the  file could not be opened, for instance, if it does not exists, then the filehandle  is Zero.
</td>
</tr>
</table>
<h1><a href=../2d_examples/ReadFile.bb>Example</a></h1>
<table>
<tr>
<td>
; Reading and writing custom types to files using ReadFile, WriteFile and  CloseFile 
<br />

<br />
; Initialise some variables for the example
<br />
Type HighScore
<br />
Field Name$
<br />
Field Score%
<br />
Field Level%
<br />
End Type
<br />

<br />
Best.HighScore = New HighScore
<br />
BestName = "Mark"
<br />
BestScore = 11657
<br />
BestLevel = 34
<br />

<br />
; Open a file to write to
<br />
fileout = WriteFile("mydata.dat")
<br />

<br />
; Write the information to the file
<br />
WriteString( fileout, BestName )
<br />
WriteInt( fileout, BestScore )
<br />
WriteByte( fileout, BestLevel )
<br />

<br />
; Close the file
<br />
CloseFile( fileout )
<br />

<br />
; Open the file to Read
<br />
filein = ReadFile("mydata.dat")
<br />
Applied docspak188. 2014-12-08 12:43:20 +13:00			`<html>`
			`<head>`
			`<title>Blitz3D Docs</title>`
			`<link rel=stylesheet href=../css/commands.css type=text/css>`
			`</head>`
			`<body>`
			`<h1>ReadFile (filename$)</h1>`
			`<h1>Parameters</h1>`
			`<table>`
			`<tr>`
			`<td>`
			`filename$ = any valid path and filename. The returned value is the filehandle which is an integer value.`
			`</td>`
			`</tr>`
			`</table>`
			`<h1>Description</h1>`
			`<table>`
			`<tr>`
			`<td>`
			`This command opens the designated filename and prepares it to be read from. Use this to read back your own configuration file, save game data, etc. also useful for reading custom types from a files. The filehandle that is returned is an integer value that the operating system uses to identify which file is to be read from and must be passed to the functions such as ReadInt(). If the file could not be opened, for instance, if it does not exists, then the filehandle is Zero.`
			`</td>`
			`</tr>`
			`</table>`
			`<h1><a href=../2d_examples/ReadFile.bb>Example</a></h1>`
			`<table>`
			`<tr>`
			`<td>`
			`; Reading and writing custom types to files using ReadFile, WriteFile and CloseFile`
			`<br />`

			`<br />`
			`; Initialise some variables for the example`
			`<br />`
			`Type HighScore`
			`<br />`
			`Field Name$`
			`<br />`
			`Field Score%`
			`<br />`
			`Field Level%`
			`<br />`
			`End Type`
			`<br />`

			`<br />`
			`Best.HighScore = New HighScore`
			`<br />`
			`BestName = "Mark"`
			`<br />`
			`BestScore = 11657`
			`<br />`
			`BestLevel = 34`
			`<br />`

			`<br />`
			`; Open a file to write to`
			`<br />`
			`fileout = WriteFile("mydata.dat")`
			`<br />`

			`<br />`
			`; Write the information to the file`
			`<br />`
			`WriteString( fileout, BestName )`
			`<br />`
			`WriteInt( fileout, BestScore )`
			`<br />`
			`WriteByte( fileout, BestLevel )`
			`<br />`

			`<br />`
			`; Close the file`
			`<br />`
			`CloseFile( fileout )`
			`<br />`

			`<br />`
Added _release/help 2014-02-26 16:08:39 +13:00			`; Open the file to Read`
Applied docspak188. 2014-12-08 12:43:20 +13:00			`<br />`
Added _release/help 2014-02-26 16:08:39 +13:00			`filein = ReadFile("mydata.dat")`
Applied docspak188. 2014-12-08 12:43:20 +13:00			`<br />`
Added _release/help 2014-02-26 16:08:39 +13:00