Delphi DLL

Read Text at a 64-bit Offset from a Remote SFTP File

Demonstrates the Chilkat SFtp.ReadFileText64 method, which reads up to a number of bytes from a specific 64-bit byte offset of an open handle and decodes them to text. The arguments are the handle, the offset, the maximum number of bytes, and the charset. The 64-bit offset supports very large files.

Background: This is the large-file counterpart to reading at a 32-bit offset: use it whenever the position you need lies beyond the ~4 GB reach of a 32-bit integer, for example seeking into a multi-gigabyte archive or database file. Everything else about the read is the same.

Chilkat Delphi DLL Downloads

Download Chilkat for Delphi DLL

Delphi DLL

var
success: Boolean;
sftp: HCkSFtp;
port: Integer;
password: PWideChar;
handle: PWideChar;
offset: HCkint64;
numBytes: Integer;
text: PWideChar;

begin
success := False;

//  Demonstrates the SFtp.ReadFileText64 method, which reads up to a number of bytes from a
//  specific 64-bit byte offset of an open handle and decodes them to text.  The 1st argument is
//  the handle, the 2nd is the offset, the 3rd is the maximum number of bytes, and the 4th is the
//  charset.  The 64-bit offset supports very large files.

sftp := CkSFtp_Create();

//  Connect, authenticate, and initialize the SFTP subsystem.
port := 22;
success := CkSFtp_Connect(sftp,'sftp.example.com',port);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  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.
password := 'mySshPassword';

success := CkSFtp_AuthenticatePw(sftp,'mySshLogin',password);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

success := CkSFtp_InitializeSftp(sftp);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

handle := CkSFtp__openFile(sftp,'subdir/hugefile.dat','readOnly','openExisting');
if (CkSFtp_getLastMethodSuccess(sftp) = False) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

//  Read 6 bytes starting at a byte offset beyond the 32-bit (4 GB) range.
offset := 5000000000;
numBytes := 6;
text := CkSFtp__readFileText64(sftp,handle,offset,numBytes,'utf-8');
if (CkSFtp_getLastMethodSuccess(sftp) = False) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;
Memo1.Lines.Add(text);

success := CkSFtp_CloseHandle(sftp,handle);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

CkSFtp_Disconnect(sftp);

CkSFtp_Dispose(sftp);