Files and resources

<< Click here to display Table of Contents >> RS/2 functions and procedures:

Files and resources

Contents

(Name:string);

Procedure

EscapeE only.

NEWFILE starts a new output file for this page. (NAME is currently ignored)

(Name:string):fileHandle;

Function

OPENFILE returns a handle to a text file for reading. Use the handle in READLINE, READCSV and EOF functions.

h:=openfile('test.txt');
while not eof(f) do
begin s:=readline(h); writeln(s); end;

Table example: Variable data

(var Handle:fileHandle):string;

Function

READLINE returns the next string read from the file specified by the HANDLE identifier (created by OPENFILE).

See also READCSV below.

(var Handle:fileHandle;var Lx:list;[Separator:string[1]]);

Procedure

READCSV returns the next CSV record from the file specified by the HANDLE identifier (created by OPENFILE) in the list specified by LX.
If SEPARATOR is not specified then a comma is used to separate the elements. Each element will contain a field from the CSV record.

A multi-line field is normalized to a string containing a number of lines delimited by 'Line Feed' (#10) characters, i.e. 'CR' (#13) is not stored. Use the SPLIT function to decompose multi-line fields.

Table example: Variable data

(var Handle:fileHandle):boolean;

Function

EOF tests if any more data can be read from a file previously opened using OPENFILE. If EOF fails, the HANDLE is no longer valid, and the file is closed.

Table example: Variable data

(FileName:string):fileHandle;

Function

CREATEFILE creates a file named FILENAME and returns a handle that can be used for WRITELINE procedure and CLOSEFILE function.

Tip: "CREATEFILE WRITELINE WRITELINE CLOSEFILE" summarizes the file create process.

(var Handle:number;S:string);

Procedure

WRITELINE writes a string S to a file previously opened with CREATEFILE function (see above).

(Handle:number):boolean;

Function

CLOSEFILE closes a file previously created with CREATEFILE function.

(FN:string):boolean;

Function

FILEEXISTS returns TRUE if the file – specified by the file named by FN string – is extant.

Table example: Variable data

(FN:string; [X,Y:number;[Scale:number;[Page:number;[Transparent:boolean[,ClipLeft,ClipTop,ClipRight,ClipBottom:number]]]]]):boolean;

Function

EscapeE only

RESOURCE function adds the designated resource to the EscapeE page. If the resource cannot be found, or the requested page does not exist in the file, the function returns FALSE.

FN must be the name of a file in a format that EscapeE can view (PCL, PDF, TIFF, RS2 etc.) and is mandatory.
X optional number of pixels at 600dpi, default 0 (left-hand side of page).
Y optional number of pixels at 600dpi, default 0 (top of page).
SCALE optional number, default 1 (i.e. unscaled).
PAGE optional number, default 1.
TRANSPARENT optional boolean, default TRUE.
CLIPLEFT, CLIPTOP, CLIPRIGHT and CLIPBOTTOM are optional numbers (default 0) specifying a clip region.

To draw a graphic at the top left-hand corner of the page:

resource('TEST.PNG');