SSH.SCPStream.Read - charonn0/RB-libssh2 GitHub Wiki
SSH.SCPStream.Read
Method Signatures
Function Read(Count As Integer, StreamID As Integer, encoding As TextEncoding = Nil) As String
Function Read(Count As Integer, encoding As TextEncoding = Nil) As String
Parameters
| Name | Type | Comment |
|---|---|---|
Count |
Integer | The number of bytes to read. |
StreamID |
Integer | Optional/Ignored. Exists because the overridden superclass method has it. |
Encoding |
TextEncoding |
Optional. The TextEncoding of the data being read. |
Return value
Returns a String containing the data that was read. If the number of bytes read exceeds the purported Length of the file then the extra bytes will be truncated.