xHarbour Reference Documentation > Function Reference

FileScreen()

Reads the contents of a screen from a file.

Syntax

FileScreen( <cFileName>, [<nOffSet>]) --> nBytesRead

Arguments

<cFilename>

This is a character string holding the name of the file to load a screen from, previously saved with ScreenFile(). It must include path and file extension. If the path is omitted from <cFileName>, the file is searched in the current directory.

<nOffSet>

If multiple screens are saved to <cFileName> an offset of (nScreenNumber-1) * nScreenSize bytes must be specified for <nOffSet> to read consecutive screens from the file. The screen size in bytes can be calulated as follows:

   nScreenSize := 2 * (MaxRow()+1) * (MaxCol()+1)

Return

The function loads a saved screen from <cFileName>, displays it and returns the number of bytes read as a numeric value.

Info

See also:	FOpen(), FRead(), SaveScreen(), ScreenFile()
Category:	CT:Video , Screen functions
Source:	ct\strfile.c
LIB:	xhb.lib
DLL:	xhbdll.dll