%FIO_WriteWholeFile function

Function

The function reads a specified file and inserts its contents into a variable of Text type.

Declaration

 BOOL %FIO_WriteWholeFile(
  TEXT in dataText
 TEXT in fileName
 [,TEXT in encoding = "@APP_DEFAULT@"]  )

Parameters

dataText	Parameter that contains the data to be written into the file.
fileName	File name (optionally full path).
encoding	Optional parameter of Text typ - type of file encoding. If it is not defined, its default value is "@APP_DEFAULT@". For reading of binary file, you must use "Binary" encoding. The list of supported encodings in ESL.

Return value

The return value is True, if the action was successful. Otherwise, it is False.

If the size of the file is bigger than the space available on the disc, the function returns invalid value.

Note

The function uses binary mode to write into the file.

Example

 BEGIN
   BOOL _out
   _out := %FIO_WriteWholeFile("Zapisovany text","c:\Info.txt")
 END