(PowerShell) SFTP Read Text File to String

Demonstrates how to download a text file from an SSH server directly into a string variable.

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 on the server:

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

# Get the total size of this file (in bytes)
$bFollowLinks = $false
$bIsHandle = $true

# bFollowLinks is ignored because we are passing a handle
# and not a remote filename.
# There are alternative methods for handling file sizes
# greater than 32-bit.  (See the reference documentation.)
$numBytes = $sftp.GetFileSize32($handle,$bFollowLinks,$bIsHandle)
if ($numBytes -lt 0) {
    $($sftp.LastErrorText)
    exit
}

# The charset indicates the character encoding of the text
# file on the SSH server.   Setting the charset correctly
# allows the Chilkat SFTP component to correctly interpret
# the bytes that represent the characters.

$charset = "ansi"

$fileContents = $sftp.ReadFileText($handle,$numBytes,$charset)
if ($sftp.LastMethodSuccess -ne $true) {
    $($sftp.LastErrorText)
    exit
}
else {
    $("Received file:")
    $($fileContents)
}

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

$("Success.")