Topics   All   Mac OS X (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server (Not)   Client   Old   Guides   Examples
New in version: 6.1   6.2   6.3   6.4   6.5   7.0   7.1   7.2   7.3   7.4    Statistic  

SSH.ReadText

Reads bytes from channel and returns them as text.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
SSH 6.3 Yes Yes Yes Yes Yes

MBS( "SSH.ReadText"; SSH { ; length; Encoding; Stream } )

Parameters

Parameter Description Example value
SSH The SSH session reference number from the plugin. $ssh
length Optional
Maximum number of bytes to read.
10
Encoding Optional
The text encoding for result.
Default is UTF-8.
Possible encoding names: ANSI, Arabic-Mac, Arabic-Win, Baltic-Win, CentralEurope-Mac, ChineseSimp-Mac, ChineseSimp-Win, ChineseTrad-Mac, ChineseTrad-Win, Cyrillic-Mac, Cyrillic-Win, EasternEurope-Win, Greek-Mac, Greek-Win, Hebrew-Mac, Hebrew-Win, ISO-8859-1, ISO-8859-2, ISO-8859-3, ISO-8859-4, ISO-8859-5, ISO-8859-6, ISO-8859-7, ISO-8859-8, ISO-8859-9, ISO-8859-15, Korean-Johab, Korean-Mac, Korean-Win, Latin1, Mac, Native, ShiftJIS-Mac, ShiftJIS-Win, Turkish-Mac, Turkish-Win, UTF-8, DOS or Windows. Pass native to use the native encoding of the current platform.
UTF8
Stream Optional
Which stream to read.
Can be stdout or stderr.
Stdout is default if parameter is empty or missing.
"StdOut"

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


SSH.ReadHex   -   SSH.Release

Feedback: Report problem or ask question.




Links
MBS Xojo tutorial videos