PureBasic

Create a Hard Link on an SFTP Server

Demonstrates the Chilkat SFtp.HardLink method, which creates a hard link to an existing remote file. The first argument is the existing file and the second is the new link path. It uses the OpenSSH hardlink@openssh.com extension and succeeds only when the server supports it.

Background: A hard link is a second name for the same file data, not a pointer to a path: both names are equal, the data persists until the last name is removed, and there is no "original" to break. Unlike a symbolic link it cannot span filesystems and cannot target a directory. Because it depends on a non-standard OpenSSH extension, expect it to fail against servers that do not implement it.

Chilkat PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

IncludeFile "CkSFtp.pb"

Procedure ChilkatExample()

    success.i = 0

    ;  Demonstrates the SFtp.HardLink method, which creates a hard link to an existing remote file.
    ;  The 1st argument is the existing file and the 2nd is the new link path.

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

    ;  Connect, authenticate, and initialize the SFTP subsystem.
    port.i = 22
    success = CkSFtp::ckConnect(sftp,"sftp.example.com",port)
    If success = 0
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    ;  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.
    password.s = "mySshPassword"

    success = CkSFtp::ckAuthenticatePw(sftp,"mySshLogin",password)
    If success = 0
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    success = CkSFtp::ckInitializeSftp(sftp)
    If success = 0
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    ;  Create a hard link.  This uses the OpenSSH hardlink@openssh.com extension and succeeds only
    ;  when the server supports it.
    success = CkSFtp::ckHardLink(sftp,"subdir/data.bin","subdir/data_backup.bin")
    If success = 0
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    Debug "Hard link created."

    CkSFtp::ckDisconnect(sftp)


    CkSFtp::ckDispose(sftp)


    ProcedureReturn
EndProcedure