Read Text at a String Offset from a Remote SFTP File

See more SFTP Examples

Demonstrates the Chilkat SFtp.ReadFileText64s method, which is like ReadFileText64 but takes the byte offset as a decimal string. The arguments are the handle, the offset string, the maximum number of bytes, and the charset.

integer li_rc
integer li_Success
oleobject loo_Sftp
integer li_Port
string ls_Password
string ls_Handle
string ls_Offset
integer li_NumBytes
string ls_Text

li_Success = 0

//  Demonstrates the SFtp.ReadFileText64s method, which is like ReadFileText64 but takes the byte
//  offset as a decimal string.  The 1st argument is the handle, the 2nd is the offset string, the
//  3rd is the maximum number of bytes, and the 4th is the charset.

loo_Sftp = create oleobject
li_rc = loo_Sftp.ConnectToNewObject("Chilkat.SFtp")
if li_rc < 0 then
    destroy loo_Sftp
    MessageBox("Error","Connecting to COM object failed")
    return
end if

//  Connect, authenticate, and initialize the SFTP subsystem.
li_Port = 22
li_Success = loo_Sftp.Connect("sftp.example.com",li_Port)
if li_Success = 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

//  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.
ls_Password = "mySshPassword"

li_Success = loo_Sftp.AuthenticatePw("mySshLogin",ls_Password)
if li_Success = 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

li_Success = loo_Sftp.InitializeSftp()
if li_Success = 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

ls_Handle = loo_Sftp.OpenFile("subdir/hugefile.dat","readOnly","openExisting")
if loo_Sftp.LastMethodSuccess = 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

//  Supplying the offset as a string is convenient in languages without a native 64-bit integer.
ls_Offset = "5000000000"
li_NumBytes = 6
ls_Text = loo_Sftp.ReadFileText64s(ls_Handle,ls_Offset,li_NumBytes,"utf-8")
if loo_Sftp.LastMethodSuccess = 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

Write-Debug ls_Text

li_Success = loo_Sftp.CloseHandle(ls_Handle)
if li_Success = 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

loo_Sftp.Disconnect()


destroy loo_Sftp