Xbase++

Write Bytes to a Remote SFTP File (BinData)

Demonstrates the Chilkat SFtp.WriteFileBd method, which appends all bytes in a BinData to the remote file identified by an open handle. The first argument is the handle and the second is the BinData.

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

Background: This is the binary counterpart to WriteFileText — the right choice for images, archives, or any non-text content, where a charset conversion would corrupt the data. Combined with an appropriate OpenFile disposition it can create, overwrite, or append; here the file is created/truncated first so the result is exactly the BinData contents.

Chilkat Xbase++ Downloads

Download Chilkat for Xbase++

Xbase++

LOCAL nSuccess
LOCAL oSftp
LOCAL nPort
LOCAL cPassword
LOCAL cHandle
LOCAL oBd

nSuccess := 0

//  Demonstrates the SFtp.WriteFileBd method, which appends all bytes in a BinData to the remote
//  file identified by an open handle.  The 1st argument is the handle and the 2nd is the BinData.

oSftp := CreateObject("Chilkat.SFtp")

//  Connect, authenticate, and initialize the SFTP subsystem.
nPort := 22
nSuccess := oSftp:Connect("sftp.example.com", nPort)
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
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.
cPassword := "mySshPassword"

nSuccess := oSftp:AuthenticatePw("mySshLogin", cPassword)
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

nSuccess := oSftp:InitializeSftp()
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  Open (creating/truncating) the remote file for writing.
cHandle := oSftp:OpenFile("subdir/image.png", "writeOnly", "createTruncate")
IF (oSftp:LastMethodSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  Put the bytes to write into a BinData.  (Here they are loaded from a local file, but the
//  bytes could come from anywhere.)
oBd := CreateObject("Chilkat.BinData")
nSuccess := oBd:LoadFile("qa_data/image.png")
IF (nSuccess == 0)
    ? oBd:LastErrorText
    oSftp:destroy()
    oBd:destroy()
    RETURN
ENDIF

//  Append the BinData bytes to the open remote file.
nSuccess := oSftp:WriteFileBd(cHandle, oBd)
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    oBd:destroy()
    RETURN
ENDIF

nSuccess := oSftp:CloseHandle(cHandle)
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    oBd:destroy()
    RETURN
ENDIF

? "Wrote " + Str(oBd:NumBytes) + " bytes."

oSftp:Disconnect()

oSftp:destroy()
oBd:destroy()