Xbase++

SFTP Get Size of File on Server

See more SFTP Examples

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

LOCAL nSuccess
LOCAL oSftp
LOCAL cHostname
LOCAL nPort
LOCAL nBFollowLinks
LOCAL nBIsHandle
LOCAL nFileSize
LOCAL cFileSizeStr
LOCAL cHandle

nSuccess := 0

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

oSftp := CreateObject("Chilkat.SFtp")

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

//  Connect to the SSH server.  
//  The standard SSH port = 22
//  The hostname may be a hostname or IP address.
cHostname := "sftp.example.com"
nPort := 22
nSuccess := oSftp:Connect(cHostname, nPort)
IF (nSuccess != 1)
    ? oSftp:LastErrorText
    oSftp:destroy()
    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.
nSuccess := oSftp:AuthenticatePw("myLogin", "myPassword")
IF (nSuccess != 1)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  After authenticating, the SFTP subsystem must be initialized:
nSuccess := oSftp:InitializeSftp()
IF (nSuccess != 1)
    ? oSftp:LastErrorText
    oSftp:destroy()
    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.
nBFollowLinks := 1
nBIsHandle := 0
nFileSize := oSftp:GetFileSize32("someDir/someFile.dat", nBFollowLinks, nBIsHandle)
IF (nFileSize < 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

? "file size = " + Str(nFileSize)

//  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.
cFileSizeStr := oSftp:GetFileSizeStr("someDir/someFile.dat", nBFollowLinks, nBIsHandle)
IF (oSftp:LastMethodSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

? "file size = " + cFileSizeStr

//  You can alternatively get the size with an open file handle.
cHandle := oSftp:OpenFile("someDir/someFile.dat", "readOnly", "openExisting")
IF (oSftp:LastMethodSuccess != 1)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  Get the size using the handle.
nBIsHandle := 1
nFileSize := oSftp:GetFileSize32("someDir/someFile.dat", nBFollowLinks, nBIsHandle)
IF (nFileSize < 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

? "file size = " + Str(nFileSize)

//  -----------------------------------------------------------------------------
//  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.
nSuccess := oSftp:CloseHandle(cHandle)
IF (nSuccess != 1)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

oSftp:destroy()