Xbase++

Write Text to a Remote SFTP File (Sequential)

Demonstrates the Chilkat SFtp.WriteFileText method, which encodes text using a charset and writes it at the current sequential write position of an open handle. The arguments are the handle, the charset, and the text.

Background: Chilkat tracks a write position per handle, so successive WriteFileText calls append naturally — the pattern for building a file a piece at a time, such as writing rows to a report. Opening with openOrCreate starts writing at the current end of the file. The charset determines the bytes actually stored, which matters whenever the text contains non-ASCII characters.

Chilkat Xbase++ Downloads

Download Chilkat for Xbase++

Xbase++

LOCAL nSuccess
LOCAL oSftp
LOCAL nPort
LOCAL cPassword
LOCAL cHandle

nSuccess := 0

//  Demonstrates the SFtp.WriteFileText method, which encodes text and writes it at the current
//  sequential write position of an open handle.  The 1st argument is the handle, the 2nd is the
//  charset, and the 3rd is the text.

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/notes.txt", "writeOnly", "createTruncate")
IF (oSftp:LastMethodSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  Write text as UTF-8.  Successive writes continue from where the previous write ended.
nSuccess := oSftp:WriteFileText(cHandle, "utf-8", "First line." + Chr(10))
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

nSuccess := oSftp:WriteFileText(cHandle, "utf-8", "Second line." + Chr(10))
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

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

? "Wrote text file."

oSftp:Disconnect()

oSftp:destroy()