(PowerShell) SFTP Read Text File

Demonstrates how to open a text file on the SSH server and read text.

Chilkat .NET Downloads Chilkat .NET Assemblies

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

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$sftp = New-Object Chilkat.SFtp

# Set some timeouts, in milliseconds:
$sftp.ConnectTimeoutMs = 5000
$sftp.IdleTimeoutMs = 15000

# Connect to the SSH server.  
# The standard SSH port = 22
# The hostname may be a hostname or IP address.
$hostname = "sftp.example.com"
$port = 22
$success = $sftp.Connect($hostname,$port)
if ($success -ne $true) {
    $($sftp.LastErrorText)
    exit
}

# Authenticate with the SSH server.  Chilkat SFTP supports
# both password-based authenication as well as public-key
# authentication.  This example uses password authenication.
$success = $sftp.AuthenticatePw("myLogin","myPassword")
if ($success -ne $true) {
    $($sftp.LastErrorText)
    exit
}

# After authenticating, the SFTP subsystem must be initialized:
$success = $sftp.InitializeSftp()
if ($success -ne $true) {
    $($sftp.LastErrorText)
    exit
}

# Open a file for reading.

$handle = $sftp.OpenFile("myTest.txt","readOnly","openExisting")
if ($sftp.LastMethodSuccess -ne $true) {
    $($sftp.LastErrorText)
    exit
}

# Assume the file we are reading contains the following text:
# abcdefghijklmnopqrstuvwxyz1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ
# (in ANSI format -- i.e. one byte per char).

# Read 26 bytes:

$sText = $sftp.ReadFileText($handle,26,"ansi")
if ($sftp.LastMethodSuccess -ne $true) {
    $($sftp.LastErrorText)
    exit
}

# Should print "abcdefghijklmnopqrstuvwxyz"
$($sText)

# Read the next 10 bytes.
$sText = $sftp.ReadFileText($handle,10,"ansi")
if ($sftp.LastMethodSuccess -ne $true) {
    $($sftp.LastErrorText)
    exit
}

# Should print "1234567890"
$($sText)

# Read the next 26 bytes.
$sText = $sftp.ReadFileText($handle,26,"ansi")
if ($sftp.LastMethodSuccess -ne $true) {
    $($sftp.LastErrorText)
    exit
}

# Should print "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
$($sText)

# Close the file.
$success = $sftp.CloseHandle($handle)
if ($success -ne $true) {
    $($sftp.LastErrorText)
    exit
}

$("Success.")