IReadStream Interface

IReadStream interface in the ABBYY FineReader Engine API — Client-side interface for a read stream (for example, reading from a file) used to supply data to FineReader Engine from a custom source.

This is the interface for a read stream. This interface and all its methods are implemented on the client-side. A read stream may be implemented, for example, as reading from file.

Methods

Name	Description
Close	Finishes using the stream. All allocated resources can be released.
Read	Reads the specified number of bytes from the stream.

Input parameter

This object is passed as an input parameter to the following methods:

• IsPdfWithTextualContentFromStream method of the Engine object
• IsPdfPortfolioFromStream method of the Engine object
• CreateLayoutFromStream method of the Engine object
• AddImageFileFromStream method of the FRDocument object in Linux and Windows

Samples

C# code

class ReadStream : IReadStream
{
 private MemoryStream fileBytes = null;
 public ReadStream( byte[] _fileBytes )
 {
  fileBytes = new MemoryStream( _fileBytes );
 }
 public void Close()
 {
  fileBytes.Close();
 }
 public int Read( out byte[] data, int count )
 {
  data = new byte[count];
  int readBytes = fileBytes.Read( data, 0, count );
  return readBytes;
 }
}

Remarks

In Linux, this interface does not work if the Engine object is loaded as an out-of-process server.

See also

FRDocument

IWriteStream

IFileWriter