FClear Function

Action

Clears all data of a file and sets the file size to zero.

Include file

Kernel.bdh

Syntax

FClear( in hFile: number ): boolean;

Return value

true if successful
false otherwise

Parameter	Description
hFile	Valid handle to an open file. This handle must have been returned from a previous call to FOpen.

Example

dcltrans
  transaction TMain
  var
    hFile : number;
    sOutput : string;
  begin
    // create new file and write string to file
    FOpen(hFile, "c:\\temp\\dummyfile.txt", OPT_FILE_ACCESS_READWRITE, OPT_FILE_CREATE);
    sOutput := "Hello world!";
    FWrite(hFile, sOutput);
    write("new file created"); writeln;

    // clear file
    FClear(hFile);
    write("file cleared"); writeln;
 
    // close file
    FClose(hFile);
    write("file closed"); writeln;
  end TMain;

Output

new file created
file cleared
file closed