(PureBasic) SFTP Get Size of File on Server

See more SFTP Examples

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

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkSFtp.pb"

Procedure ChilkatExample()

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

    sftp.i = CkSFtp::ckCreate()
    If sftp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Set some timeouts, in milliseconds:
    CkSFtp::setCkConnectTimeoutMs(sftp, 5000)
    CkSFtp::setCkIdleTimeoutMs(sftp, 10000)

    ; Connect to the SSH server.  
    ; The standard SSH port = 22
    ; The hostname may be a hostname or IP address.
    hostname.s = "sftp.example.com"
    port.i = 22
    success.i = CkSFtp::ckConnect(sftp,hostname,port)
    If success <> 1
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    ; Authenticate with the SSH server.  Chilkat SFTP supports
    ; both password-based authenication as well as public-key
    ; authentication.  This example uses password authenication.
    success = CkSFtp::ckAuthenticatePw(sftp,"myLogin","myPassword")
    If success <> 1
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    ; After authenticating, the SFTP subsystem must be initialized:
    success = CkSFtp::ckInitializeSftp(sftp)
    If success <> 1
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    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.
    bFollowLinks.i = 1
    bIsHandle.i = 0
    fileSize.i = CkSFtp::ckGetFileSize32(sftp,"someDir/someFile.dat",bFollowLinks,bIsHandle)
    If fileSize < 0
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    Debug "file size = " + Str(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.
    fileSizeStr.s = CkSFtp::ckGetFileSizeStr(sftp,"someDir/someFile.dat",bFollowLinks,bIsHandle)
    If CkSFtp::ckLastMethodSuccess(sftp) = 0
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    Debug "file size = " + fileSizeStr

    ; You can alternatively get the size with an open file handle.
    handle.s = CkSFtp::ckOpenFile(sftp,"someDir/someFile.dat","readOnly","openExisting")
    If CkSFtp::ckLastMethodSuccess(sftp) <> 1
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    ; Get the size using the handle.
    bIsHandle = 1
    fileSize = CkSFtp::ckGetFileSize32(sftp,"someDir/someFile.dat",bFollowLinks,bIsHandle)
    If fileSize < 0
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    Debug "file size = " + Str(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.
    success = CkSFtp::ckCloseHandle(sftp,handle)
    If success <> 1
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf



    CkSFtp::ckDispose(sftp)


    ProcedureReturn
EndProcedure