System.ZLib.TZCompressionStream.OnProgress

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property OnProgress: TNotifyEvent read FOnProgress write FOnProgress;

C++

__property OnProgress;

Properties

Type Visibility Source Unit Parent
event public
System.ZLib.pas
System.ZLib.hpp
System.ZLib TZCompressionStream

Description

Occurs when reading or writing a large block of data in a single call.

System.ZLib.TZCompressionStream.OnProgress inherits from System.ZLib.TCustomZStream.OnProgress. All content below this line refers to System.ZLib.TCustomZStream.OnProgress.

Occurs when reading or writing a large block of data in a single call.

Classes derived from TCustomZStream can use the OnProgress event to perform an action during a long read or write operation.

For example, the TCompressionStream class calls the OnProgress event handler, after the stream's output buffer has been filled and subsequently written. Similarly, the TDecompressionStream class calls the OnProgress event handler when its input buffer has been filled and is ready to be decompressed. You can use the OnProgress event to update a user interface control, such as a progress indicator. You can use the Position property, inherited from TStream, to determine the number of raw (uncompressed) bytes written to the output stream so far.

See Also