This function retrieves the path of the given file.

OOP Syntax Help! I don't understand this!

• Method: file:getPath(...)
• Variable: .path

Syntax

string|false fileGetPath ( file theFile )

Required Arguments

• theFile: The file you want to get the path.

Returns

• string|false: result

Returns a string representing the file path, false if invalid file was provided.

Code Examples

Example 1 Example 2 (OOP)

shared

local newFile = fileCreate("test.txt")                -- attempt to create a new file
if (newFile) then                                       -- check if the creation succeeded
    local path = fileGetPath(newFile)
    outputChatBox("New file created at: "..path, root, 0, 255, 0)
    fileClose(newFile)                                -- close the file once you're done with it
end

shared

OOP Required

local newFile = File.new("test.txt")                -- attempt to create a new file
if (newFile) then                                       -- check if the creation succeeded
    local path = newFile.path
    root:outputChat("New file created at: "..path, 0, 255, 0)
    newFile:close()                                -- close the file once you're done with it
end

See Also

File Functions

• fileClose
• fileCopy
• fileCreate
• fileDelete
• fileExists
• fileFlush
• fileGetContents
• fileGetHash
• fileGetPath
• fileGetPos
• fileGetSize
• fileIsEOF
• fileRead
• fileOpen
• fileRename
• fileSetPos
• fileWrite

File Elements

• file

Reference

• Scripting Functions