Back to product page

Peek method


Receives incoming data without removing it from the buffer.

Type

A String value

Syntax

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

Remarks

The Peek method will return the contents of the incoming buffer, without removing it from the buffer. It can be used to check if the expected data has been received so that it can be read all at once. You can call the Peek method as many times as you like - it will not block wodSSH in any way (whether or not Blocking is set).

This method will always return a string expression - unlike the Receive method it cannot return byte arrays.

Platforms

Windows