Lianja

SFTP Get Size of File on Server

See more SFTP Examples

Demonstrates how to get the size of an existing file on the server. Lianja

llSuccess = .F.

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

loSftp = createobject("CkSFtp")

// Set some timeouts, in milliseconds:
loSftp.ConnectTimeoutMs = 5000
loSftp.IdleTimeoutMs = 10000

// Connect to the SSH server.  
// The standard SSH port = 22
// The hostname may be a hostname or IP address.
lcHostname = "sftp.example.com"
lnPort = 22
llSuccess = loSftp.Connect(lcHostname,lnPort)
if (llSuccess <> .T.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

// Authenticate with the SSH server.  Chilkat SFTP supports
// both password-based authenication as well as public-key
// authentication.  This example uses password authenication.
llSuccess = loSftp.AuthenticatePw("myLogin","myPassword")
if (llSuccess <> .T.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

// After authenticating, the SFTP subsystem must be initialized:
llSuccess = loSftp.InitializeSftp()
if (llSuccess <> .T.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

// Assuming we know the file size won't be too large, we get the size as a 32-bit integer.
// For SFTP, the remote file path is always either a path relative to the HOME directory of the user account, or an absolute path on the server.
llBFollowLinks = .T.
llBIsHandle = .F.
lnFileSize = loSftp.GetFileSize32("someDir/someFile.dat",llBFollowLinks,llBIsHandle)
if (lnFileSize < 0) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

? "file size = " + str(lnFileSize)

// If the file size might be too large for a 32-bit signed integer, then get the size as a decimal string.
// You can convert the string to a 64-bit integer in your programming language.
lcFileSizeStr = loSftp.GetFileSizeStr("someDir/someFile.dat",llBFollowLinks,llBIsHandle)
if (loSftp.LastMethodSuccess = .F.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

? "file size = " + lcFileSizeStr

// You can alternatively get the size with an open file handle.
lcHandle = loSftp.OpenFile("someDir/someFile.dat","readOnly","openExisting")
if (loSftp.LastMethodSuccess <> .T.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

// Get the size using the handle.
llBIsHandle = .T.
lnFileSize = loSftp.GetFileSize32("someDir/someFile.dat",llBFollowLinks,llBIsHandle)
if (lnFileSize < 0) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

? "file size = " + str(lnFileSize)

// -----------------------------------------------------------------------------
// Don't forget to close the file handle.
// Otherwise open handles will accumulate on the server until eventually a limit
// is reached and the server will fail on a call to OpenFile.
// -----------------------------------------------------------------------------

// Close the file.
llSuccess = loSftp.CloseHandle(lcHandle)
if (llSuccess <> .T.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif



release loSftp