SSHRead (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

SSHRead (Function)

In french: SSHLit

Reads the data found on the output buffer of the SSH session.

Versions 25 and later

This function is now available for iPhone/iPad applications.

This function is now available for Android applications.

This function is now available in Android widget mode.

This function is now available for WEBDEV applications in Linux.

This function is now available for WINDEV applications in Linux.

New in version 25

This function is now available for iPhone/iPad applications.

This function is now available for Android applications.

This function is now available in Android widget mode.

This function is now available for WEBDEV applications in Linux.

This function is now available for WINDEV applications in Linux.

This function is now available for iPhone/iPad applications.

This function is now available for Android applications.

This function is now available in Android widget mode.

This function is now available for WEBDEV applications in Linux.

This function is now available for WINDEV applications in Linux.

Example

See additional examples

// The session was started by SSHConnectShell

// Read the console of SSH shell after sending a command
// with SSHWrite
WHILE True

// Consume the content of the console by leaving 1s rest
sStdBuffer = SSHRead(cMySession, 1000, sshStandardOutput)

// As long as the console is empty
IF sStdBuffer = "" THEN
...
// See the full example
...
END
END

Syntax

<Result> = SSHRead(<SSH session> , <Timeout> [, <Output stream>])

<Result>: Buffer

Data read on the SSH session.

<SSH session>: sshSession variable

Name of the sshSession variable corresponding to the SSH session to use.

<Timeout>: Integer ou Duration

Maximum timeout to receive the data (expressed in milliseconds). This parameter can correspond to:
an integer corresponding to the number of milliseconds,
a Duration variable,
Versions 23 and later
the duration in a readable format (e.g., 1 s or 10 ms).
New in version 23
the duration in a readable format (e.g., 1 s or 10 ms).
the duration in a readable format (e.g., 1 s or 10 ms).
This parameter is set to 1000 ms by default.

<Output stream>: Optional Integer constant

Type of stream to read:
sshErrorOutput The data is read on the output buffer if an error occurred.
sshStandardOutput
(default value) The data is read on the standard output buffer.

Business / UI classification: Business Logic

Component: wd270com.dll