Lua

Check if File Exists

See more SFTP Examples

Demonstrates how to check to see if a file exists. Lua

local chilkat = require("chilkat")

-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.

local sftp = chilkat.SFtp.new()

-- Connect to the SSH server.
local hostname = "sftp.example.com"
local port = 22
local success = sftp:connect(hostname, port)
if not success then
    print(sftp.last_error_text)
    return
end

-- Authenticate with the SSH server.  Chilkat SFTP supports
-- both password-based authenication as well as public-key
-- authentication.  This example uses password authenication.
success = sftp:authenticate_pw("myLogin", "myPassword")
if not success then
    print(sftp.last_error_text)
    return
end

-- After authenticating, the SFTP subsystem must be initialized:
success = sftp:initialize_sftp()
if not success then
    print(sftp.last_error_text)
    return
end

-- Check to see if a file exists

-- The return value is one of the following values:
-- -1: Unable to check. Examine the LastErrorText to determine the reason for failure.
-- 0: File does not exist.
-- 1: The regular file exists.
-- 2: It exists, but it is a directory.
-- 3: It exists, but it is a symlink (only possible if followLinks is false)
-- 4: It exists, but it is a special filesystem entry type.
-- 5: It exists, but it is an unkown filesystem entry type.
-- 6: It exists, but it is an socket filesystem entry type.
-- 7: It exists, but it is an char device entry type.
-- 8: It exists, but it is an block device entry type.
-- 9: It exists, but it is an FIFO entry type.

local followLinks = true
local status = sftp:file_exists("someDir/someFile.txt", followLinks)
if status < 0 then
    print(sftp.last_error_text)
    return
end

print("status = " .. status)

print("Success")