DataFlex

Initialize the SFTP Subsystem

Demonstrates the Chilkat SFtp.InitializeSftp method, which opens the SFTP subsystem and negotiates the SFTP protocol version. It takes no arguments and must be called after connecting and authenticating, before any file or directory operation.

Background: SFTP is not a standalone protocol but a subsystem requested over an authenticated SSH session, which is why this separate step exists. It is also where the SFTP protocol version is negotiated — that version determines which capabilities (such as certain timestamp and path-composition features) are available for the session. Skipping this call, or calling it before authentication, leaves every file operation failing.

Chilkat DataFlex Downloads

Download Chilkat for DataFlex

DataFlex

Use ChilkatAx-win32.pkg

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

    Move False To iSuccess

    //  Demonstrates the SFtp.InitializeSftp method, which opens the SFTP subsystem and negotiates the
    //  SFTP protocol version.  It takes no arguments and must be called after connecting and
    //  authenticating, before any file or directory operations.

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

    //  Step 1: Connect the SSH transport.  Port 22 is the usual port.
    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

    //  Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
    //  file or directory operations.
    Get ComInitializeSftp Of hoSftp To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Showln "The SFTP subsystem is ready."

    Send ComDisconnect To hoSftp


End_Procedure