PowerShell

Get the Byte Count of the Last SFTP Read

Demonstrates the Chilkat SFtp.LastReadNumBytes method, which returns the number of bytes received by the most recent read for a handle. The only argument is the handle.

Background: SFTP reads may return fewer bytes than requested even before the end of the file, so knowing the actual count is useful for tracking progress and for advancing an explicit offset by the right amount. Both a normal EOF read and a failed read report 0, so pair this with Eof and LastReadFailed to interpret a zero-byte result correctly.

Chilkat PowerShell Downloads

Download Chilkat for PowerShell

PowerShell

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

$success = $false

#  Demonstrates the SFtp.LastReadNumBytes method, which returns the number of bytes received by
#  the most recent read for a handle.  The only argument is the handle.

$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/data.txt","readOnly","openExisting")
if ($sftp.LastMethodSuccess -eq $false) {
    $($sftp.LastErrorText)
    exit
}

$bd = New-Object Chilkat.BinData
$chunkSize = 4096
$reading = $true
while ($reading) {
    $success = $sftp.ReadFileBd($handle,$chunkSize,$bd)
    if ($sftp.LastReadFailed($handle)) {
        $($sftp.LastErrorText)
        exit
    }

    #  Report how many bytes the last read actually returned.  A normal EOF read reports 0.
    $lastCount = $sftp.LastReadNumBytes($handle)
    $("Last read returned " + $lastCount + " bytes.")

    $reading = !$sftp.Eof($handle)
}

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

$("Total: " + $bd.NumBytes + " bytes.")

$sftp.Disconnect()