Xceed Zip Compression Library Documentation
BackgroundProcessing property
Xceed Zip control reference > Xceed Zip control properties > BackgroundProcessing property

Description

The BackgroundProcessing property controls whether or not Xceed Zip methods are executed immediately or are run as background processes.

Normally this property is set to False, so method calls are not executed as background processes, and the entire operation is processed immediately and returns the real result code for the operation. When the BackgroundProcessing property is set to True, the operation starts immediately, however the ResultCode is also immediately set to xerProcessStarted and the code following the method call is executed. When the zip operation finally completes, the ProcessCompleted event is triggered, and provides the real result code for the operation, as well as statistics on the operation.

Data type

Boolean

Default value

False

Declaration (DLL API)  

BOOL XzGetBackgroundProcessing( HXCEEDZIP hZip )

void XzSetBackgroundProcessing( HXCEEDZIP hZip, BOOL bValue )

Remarks

A separate thread is started by the library in order to accomplish the capability provided by setting this property to True. This property is useful when you need methods to be executed asynchronously.

Applicable methods

All methods except for the AddFilesToProcess, AddFilesToExclude, SfxAddExtentionToAssociate and SfxAddProgramGroupItem methods, which don't launch an operation at all.