| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
SSH.ReadText
Reads bytes from channel and returns them as text.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| SSH | 6.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "SSH.ReadText"; SSH { ; length; Encoding; Stream } ) More
Parameters
| Parameter | Description | Example | Flags |
|---|---|---|---|
| SSH | The SSH session reference number from the plugin. | $ssh | |
| length | Maximum number of bytes to read. | 10 | Optional |
| Encoding | The text encoding for result. Default is UTF-8. Possible encoding names: ANSI, ISO-8859-1, Latin1, Mac, Native, UTF-8, DOS, Hex, Base64 or Windows. More listed in the FAQ. |
UTF8 | Optional |
| Stream | Which stream to read. Can be stdout or stderr. Stdout is default if parameter is empty or missing. |
"StdOut" | Optional |
Result
Returns text or error message.
Description
Reads bytes from channel and returns them as text.The text returned may be shorter than length bytes.
Examples
Read all text:
# We read text in several chunks until no new text is coming any more:
Set Variable [$text; Value:""]
Loop
Pause/Resume Script [Duration (seconds): ,1]
# Read some text:
Set Variable [$newtext; Value:MBS( "SSH.ReadText"; $ssh; 10000; "UTF8" )]
If [MBS("iserror") = 0]
If [Length($newText) > 0]
Set Variable [$text; Value:$text & $newText]
End If
Exit Loop If [Length($newText) = 0]
End If
End Loop
Set Field [SSH::Result; $text]
See also
Example Databases
This function checks for a license.
Created 29th May 2016, last changed 27th May 2017
