Sample code for 30+ languages & platforms
Lianja

Get a Remote File's Size (32-bit)

See more SFTP Examples

Demonstrates the Chilkat SFtp.GetFileSize32 method, which returns a remote file's size in bytes as a 32-bit integer. The arguments are the remote path (or handle), whether symbolic links are followed, and whether the first argument is a handle.

Background: A 32-bit signed integer tops out near 2 GB, so this is fine for ordinary files but will misreport or fail for larger ones. When a file might exceed that, use GetFileSizeStr, which returns the size as a decimal string and cannot overflow. The two boolean arguments are shared by all the attribute getters: the first follows symbolic links to their target, and the second says whether you passed a path or an open handle.

Chilkat Lianja Downloads

Lianja
llSuccess = .F.

//  Demonstrates the SFtp.GetFileSize32 method, which returns a remote file's size in bytes as a
//  32-bit integer.  The 1st argument is the remote path (or handle), the 2nd selects whether
//  symbolic links are followed, and the 3rd indicates whether the 1st argument is a handle.

loSftp = createobject("CkSFtp")

//  Connect, authenticate, and initialize the SFTP subsystem.
lnPort = 22
llSuccess = loSftp.Connect("sftp.example.com",lnPort)
if (llSuccess = .F.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

//  Normally you would not hard-code the password in source.  You should instead obtain it
//  from an interactive prompt, environment variable, or a secrets vault.
lcPassword = "mySshPassword"

llSuccess = loSftp.AuthenticatePw("mySshLogin",lcPassword)
if (llSuccess = .F.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

llSuccess = loSftp.InitializeSftp()
if (llSuccess = .F.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

//  The 2nd argument (bFollowLinks) selects whether a symbolic link is followed to its target.
//  The 3rd argument (bIsHandle) is .F. here because the 1st argument is a path, not an
//  open handle.
llBFollowLinks = .T.
llBIsHandle = .F.

lnFileSize = loSftp.GetFileSize32("subdir/report.pdf",llBFollowLinks,llBIsHandle)
if (lnFileSize < 0) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

? "File size: " + str(lnFileSize) + " bytes"

//  Note: For files that may exceed 2 GB, use GetFileSizeStr (returns a decimal string) instead,
//  because the value can overflow a 32-bit integer.

loSftp.Disconnect()


release loSftp