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

See more SFTP Examples

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.

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$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 = New-Object Chilkat.SFtp

#  Connect, authenticate, and initialize the SFTP subsystem.
$port = 22
$success = $sftp.Connect("sftp.example.com",$port)
if ($success -eq $false) {
    $($sftp.LastErrorText)
    exit
}

#  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 = $sftp.AuthenticatePw("mySshLogin",$password)
if ($success -eq $false) {
    $($sftp.LastErrorText)
    exit
}

$success = $sftp.InitializeSftp()
if ($success -eq $false) {
    $($sftp.LastErrorText)
    exit
}

$handle = $sftp.OpenFile("subdir/hugefile.dat","readOnly","openExisting")
if ($sftp.LastMethodSuccess -eq $false) {
    $($sftp.LastErrorText)
    exit
}

#  Read 6 bytes starting at a byte offset beyond the 32-bit (4 GB) range.
$offset = 5000000000
$numBytes = 6
$text = $sftp.ReadFileText64($handle,$offset,$numBytes,"utf-8")
if ($sftp.LastMethodSuccess -eq $false) {
    $($sftp.LastErrorText)
    exit
}

$($text)

$success = $sftp.CloseHandle($handle)
if ($success -eq $false) {
    $($sftp.LastErrorText)
    exit
}

$sftp.Disconnect()