PowerBuilder

SFTP Get Size of File on Server

See more SFTP Examples

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

integer li_rc
integer li_Success
oleobject loo_Sftp
string ls_Hostname
integer li_Port
integer li_BFollowLinks
integer li_BIsHandle
integer li_FileSize
string ls_FileSizeStr
string ls_Handle

li_Success = 0

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

loo_Sftp = create oleobject
li_rc = loo_Sftp.ConnectToNewObject("Chilkat.SFtp")
if li_rc < 0 then
    destroy loo_Sftp
    MessageBox("Error","Connecting to COM object failed")
    return
end if

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

// Connect to the SSH server.  
// The standard SSH port = 22
// The hostname may be a hostname or IP address.
ls_Hostname = "sftp.example.com"
li_Port = 22
li_Success = loo_Sftp.Connect(ls_Hostname,li_Port)
if li_Success <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

// Authenticate with the SSH server.  Chilkat SFTP supports
// both password-based authenication as well as public-key
// authentication.  This example uses password authenication.
li_Success = loo_Sftp.AuthenticatePw("myLogin","myPassword")
if li_Success <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

// After authenticating, the SFTP subsystem must be initialized:
li_Success = loo_Sftp.InitializeSftp()
if li_Success <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

// 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.
li_BFollowLinks = 1
li_BIsHandle = 0
li_FileSize = loo_Sftp.GetFileSize32("someDir/someFile.dat",li_BFollowLinks,li_BIsHandle)
if li_FileSize < 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

Write-Debug "file size = " + string(li_FileSize)

// 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.
ls_FileSizeStr = loo_Sftp.GetFileSizeStr("someDir/someFile.dat",li_BFollowLinks,li_BIsHandle)
if loo_Sftp.LastMethodSuccess = 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

Write-Debug "file size = " + ls_FileSizeStr

// You can alternatively get the size with an open file handle.
ls_Handle = loo_Sftp.OpenFile("someDir/someFile.dat","readOnly","openExisting")
if loo_Sftp.LastMethodSuccess <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

// Get the size using the handle.
li_BIsHandle = 1
li_FileSize = loo_Sftp.GetFileSize32("someDir/someFile.dat",li_BFollowLinks,li_BIsHandle)
if li_FileSize < 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

Write-Debug "file size = " + string(li_FileSize)

// -----------------------------------------------------------------------------
// 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.
li_Success = loo_Sftp.CloseHandle(ls_Handle)
if li_Success <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if



destroy loo_Sftp