Difference between revisions of "OpenFile"

From SCAR Divi Manual
Jump to: navigation, search
(Example)
Line 8: Line 8:
  
 
==Description==
 
==Description==
Opens a file specified by '''Path''' for reading access if it is a valid path name. If the path name is valid it will return the handle of the file stream to the file in the files resource manager, if not, it raises an exception. If '''Shared''' is [[true]], the file can be accessed by other processes while it is in use by SCAR Divi, if it is [[false]] the script gets exclusive access until [[CloseFile]] is used to close the file stream.
+
Opens a file specified by '''Path''' for reading access. If the path name is valid it will return the handle of the file stream to the file in the files resource manager, if not, it raises an exception. If '''Shared''' is [[true]], the file can be accessed by other processes while it is in use by SCAR Divi, if it is [[false]] the script gets exclusive access until [[CloseFile]] is used to close the file stream. If you wish to write a file you can use the [[RewriteFile]] function.
  
 
==Example==
 
==Example==

Revision as of 10:33, 1 July 2011

Definition

function OpenFile(Path: string; Shared: Boolean): Integer;

Availability

SCAR Divi 3.00 > Current

Description

Opens a file specified by Path for reading access. If the path name is valid it will return the handle of the file stream to the file in the files resource manager, if not, it raises an exception. If Shared is true, the file can be accessed by other processes while it is in use by SCAR Divi, if it is false the script gets exclusive access until CloseFile is used to close the file stream. If you wish to write a file you can use the RewriteFile function.

Example

var
  f: Integer;
  s: string;

begin
  f := Rewritefile(LogsPath + 'Test.txt', False);
  WriteFileString(f, 'Hello World!');
  CloseFile(f);

  f := OpenFile(LogsPath + 'Test.txt', False);
  ReadFileString(f, s, FileSize(f))
  WriteLn(s);
  CloseFile(f);

  DeleteFile(LogsPath + 'Test.txt');
end.

See Also