Back to product page
- Introduction
- Overview
- License Agrement
- Getting Started
- Objects
- Enumerations
- wodSSH
- Methods
- Properties
- AllocatePty
- Authentication
- Blocking
- ClientName
- Columns
- Command
- Compression
- DataOut
- DataReady
- Encoding
- Encryption
- EncryptionList
- ErrorText
- ExitSignal
- ExitStatus
- FIPS
- ForwardHost
- ForwardPort
- HMacList
- Hostname
- KeepAlives
- KeyExchangeList
- KeyForward
- KeySignatureList
- LastError
- Login
- MyHostname
- MyIP
- Notification
- Password
- Port
- PrivateKey
- Prompt
- Protocol
- ProxyHostname
- ProxyLogin
- ProxyPassword
- ProxyPort
- ProxyType
- RemoteIdentification
- Rows
- ShowStdErrorMessages
- State
- StateText
- StripANSI
- StripNull
- Subsystem
- TerminalSpeed
- TerminalType
- Timeout
- UseIPv6
- Version
- Events
- IwodSSHNotify
- How to get support?
- Technical information
- Fast notifications interface
- Error list
ReceiveLine method
Receives a line of text, if available.
Type
A String value. Received line with data in a string expression.Syntax
- Basic
object.ReceiveLine ()
The ReceiveLine(object) syntax has these parts:
The ReceiveLine(object) syntax has these parts:
object | An expression evaluating to an object of type wodSSH. |
Remarks
The ReceiveLine method will return a full line from the buffer, if one exists. wodSSH will remove end-of-line markers (vbLf, vbCr and vbCrLf) so when you get a line of text you don't need to trim or remove these special codes.If no line can be found in the buffer (i.e. there are no CR/LF bytes to indicate the end of a line) then the component will return error 30043 ("None found"). If wodSSH returns an empty string this means that it found a blank string terminated with CR/LF characters and there may be more lines to read.
Unlike the Receive method, this method only returns string expressions and cannot return a byte array. In Blocking mode, wodSSH will wait until Timeout expires to receive a full line if it does not find one in the buffer.