MTA:Eir/FileSystem/translator/absPathRoot: Difference between revisions
Jump to navigation
Jump to search
(Created page with "__NOTOC__ This function resolves a specified path into its absolute version. The path is resolved from the translator root. This function can be used to get a unique version of a...") |
No edit summary |
||
| Line 8: | Line 8: | ||
==Arguments== | ==Arguments== | ||
*'''path:''' the path that should be resolved into | *'''path:''' the path that should be resolved into an absolute path; can be nil to return the absolute location of the translator (on host filesystems such as NTFS or ext3) | ||
==Returns== | ==Returns== | ||
Revision as of 23:25, 29 January 2014
This function resolves a specified path into its absolute version. The path is resolved from the translator root. This function can be used to get a unique version of a path (without scripting symbols such as '..').
Syntax
string translator.absPathRoot ( string path )
Arguments
- path: the path that should be resolved into an absolute path; can be nil to return the absolute location of the translator (on host filesystems such as NTFS or ext3)
Returns
This function returns the absolute version of the path that is passed to it, false if the specified path is not accessible by the translator.
Example
Click to collapse [-]
ClientThis snippet checks whether the path given to it is valid for the resource.
-- Get a handle to the resource instance directory.
local resRoot = fileCreateTranslator( "/" );
-- Create our utility function.
local function isPathValidForResource( path )
return not ( resRoot.absPathRoot( path ) == false );
end
-- Is the path inside of/valid for our resource? Should return false.
local myPathValidity = isPathValidForResource( "C:/Windows/System32/" );
outputChatBox( "the windows system directory is " .. ( myPathValidity and "" or "not " ) .. "valid." );