<sshSession variable>.Read (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Communication

SSH functions

Prefix syntax

Read

Presentation

Example

See also

<sshSession variable>.Read (Function)

In french: <Variable sshSession>.Lit

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

Example

// The session has been started by <sshSession>.ConnectShell
cMySession is sshSession

// 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 = cMySession.Read(1000, sshStandardOutput)

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

Syntax

<Result> = <SSH session>.Reads(<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 be used.

<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,
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.

Component: wd280com.dll