DataFlex

Download from an SFTP Server Using an Open Handle

Demonstrates the Chilkat SFtp.DownloadFile method, which streams a remote file identified by an open handle to a local path. The first argument is the handle (from OpenFile) and the second is the local file path. Close the handle with CloseHandle when done.

Note: This example uses relative local paths, which are resolved against the application's current working directory. Absolute local paths may also be used. Supply the paths appropriate to your own environment.

Background: The handle-based counterpart to DownloadFileByName. Opening the file yourself lets you set read options — such as requesting exclusive read access — that the convenience method does not expose, and it separates the open step from the transfer so the handle can be used for more than one operation. As with any handle, close it when finished to release the server-side resource.

Chilkat DataFlex Downloads

Download Chilkat for DataFlex

DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoSftp
    Integer iPort
    String sPassword
    String sHandle
    String sTemp1
    Boolean bTemp1

    Move False To iSuccess

    //  Demonstrates the SFtp.DownloadFile method, which streams a remote file identified by an open
    //  handle to a local path.  The 1st argument is the handle and the 2nd is the local file path.

    Get Create (RefClass(cComChilkatSFtp)) To hoSftp
    If (Not(IsComObjectCreated(hoSftp))) Begin
        Send CreateComObject of hoSftp
    End

    //  Connect, authenticate, and initialize the SFTP subsystem.
    Move 22 To iPort
    Get ComConnect Of hoSftp "sftp.example.com" iPort To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    //  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.
    Move "mySshPassword" To sPassword

    Get ComAuthenticatePw Of hoSftp "mySshLogin" sPassword To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComInitializeSftp Of hoSftp To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    //  Open the remote file for reading.  OpenFile returns a handle string.
    Get ComOpenFile Of hoSftp "subdir/report.pdf" "readOnly" "openExisting" To sHandle
    Get ComLastMethodSuccess Of hoSftp To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    //  Stream the remote file to the local filesystem.  The transfer is not limited by memory.
    Get ComDownloadFile Of hoSftp sHandle "qa_output/report.pdf" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    //  Close the remote handle when the download is complete.
    Get ComCloseHandle Of hoSftp sHandle To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Showln "Downloaded."

    Send ComDisconnect To hoSftp


End_Procedure