Discuss this help topic in SecureBlackbox Forum

TElSftpStream.Read

TElSftpStream     See also     


Filter: C#/Java  VB.NET  Pascal  C++  PHP  


Reads a block of data from the stream and writes it to the given buffer.

Declaration

[C#/Java]
    int Read(byte[] Buffer, int Offset, int Count);

[VB.NET]
    Function Read(ByVal Buffer As Byte(), ByVal Offset As Integer, ByVal Count As Integer) As Integer

[Pascal]
    function Read(var Buffer; Count : Longint) : Longint;

[C++]
    int32_t Read(void * Buffer, int32_t Count);

[PHP]
    integer Read(TSBPointer|array of byte|string $Buffer, integer $Count)

Parameters

  • Buffer - the buffer where the read data will be placed.
  • Offset - the byte offset in Buffer where the read bytes will be placed.
  • Count - the maximum number of bytes to read.

Return value

    Returns the total number of bytes that were read.

Description

    Use this method to read data from the stream. The requested number of bytes are read and placed to the buffer starting from the desired offset.

See also:     Seek     Write    

Discuss this help topic in SecureBlackbox Forum