TFile.CheckAccess

From Soldat Community Wiki
Revision as of 15:48, 26 July 2013 by Falcon (talk | contribs) (Created page with " '''''function CheckAccess(const FilePath: string): Boolean''''' FilePath: a path to a file to check access for Result: Whenever file is accessible from script's sandbox o...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
function CheckAccess(const FilePath: string): Boolean
 FilePath: a path to a file to check access for
 Result: Whenever file is accessible from script's sandbox or not

Description

This function checks whenever file pointed by FilePath can be opened by script's File API.

Path syntax

Path to a file should be passed in unix-like syntax (slashes, not backslashes) where first character determinates where is the start point:

  • /: if path begins from slash (/), it's assumed to start from hard disk root ("root / folder on unix, Disk on which soldatserver is located on windows (i.e. C:\)
  • ~: if path begins from tylda (~), it's assumed to start from script's data directory (soldatserver/scripts/yourscriptname/data/)
  • Any else character is assumed to be part of the path and start point is set to soldatserver's directory, i.e. 'soldat.ini' points to soldatserver/soldat.ini.

Example

  
begin
  if File.CheckAccess('soldat.ini') then
    WriteLn('soldat ini seems to be accessible!')
  else
    WriteLn('access to soldat.ini denied.');
end;