System.ZLib.TZDecompressionStream.Read

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function Read(var buffer; count: Longint): Longint; override;
function Read(Buffer: TBytes; Offset, Count: Longint): Longint; override;

C++

virtual int __fastcall Read(void *buffer, int count)/* overload */;
virtual int __fastcall Read(System::DynamicArray<System::Byte> Buffer, int Offset, int Count)/* overload */;
inline int __fastcall  Read(System::DynamicArray<System::Byte> &Buffer, int Count){ return System::Classes::TStream::Read(Buffer, Count); }

Properties

Type Visibility Source Unit Parent
function public
System.ZLib.pas
System.ZLib.hpp
System.ZLib TZDecompressionStream

Description

Reads a block of data from the input stream, decompresses it, and stores it in the supplied buffer.

The buffer parameter is the destination for the decompressed data.

The count parameter specifies the size of the destination buffer. The Read operation ends when the destination buffer is full, or when there are no more bytes available to be read from the input stream.

After reading a block of data, the OnProgress event is fired by the object. This gives you a chance to update a user interface control such as a progress indicator during a long Read operation.

The result of the Read operation is the number of decompressed bytes placed into the destination buffer.

See Also