Back to product page

PeekLine method


Receives an incoming line without removing it from the buffer.

Type

A String value

Syntax

  • Basic
object.PeekLine ()
The PeekLine(object) syntax has these parts:
objectAn expression evaluating to an object of type wodSSH.

Remarks

The PeekLine method will return a full line of text, if it exists, in the incoming buffer, without removing it from the buffer. wodSSH will remove end-of-line markers (CR/LF) so you don't need to trim this string by yourself. If no line is found, wodSSH will return error 30043 ("None found"), and will not wait for data to arrive.

To actually remove data from the incoming buffer, you should use the Receive or ReceiveLine methods.

Platforms

Windows