Difference between revisions of "TPlayers.Add"
(→Example) |
|||
Line 1: | Line 1: | ||
− | '''''function | + | '''''function CheckAccess(const FilePath: string): Boolean''''' |
− | + | FilePath: a path to a file to check access for | |
− | Result: | + | Result: Whenever file is accessible from script's sandbox or not |
==Description== | ==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 tilde ('''~'''), 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 == | == Example == | ||
− | <syntaxhighlight lang="pascal"> | + | <syntaxhighlight lang="pascal"> |
− | + | begin | |
− | + | if File.CheckAccess('soldat.ini') then | |
− | + | WriteLn('soldat ini seems to be accessible!') | |
− | + | else | |
− | + | WriteLn('access to soldat.ini denied.'); | |
− | + | end; | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</syntaxhighlight> | </syntaxhighlight> | ||
− | [[Category: | + | [[Category:TFile]] |
Revision as of 14:47, 26 July 2013
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 tilde (~), 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;