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

Description

The Abort property allows you to stop the execution of a currently running Xceed Zip method.

At any time during the execution of an Xceed Zip method, setting the Abort property to True will cause the currently executing method to abort and return the xerUserAbort value, which indicates that the abort was successful. The Abort property is automatically set back to False whenever a new method is called.

In order to properly terminate the current operation, the response to the Abort property is not always instantaneous.

This property is not browsable by an object browser.

Data type

Boolean

Default value

False

Declaration (DLL API)  

BOOL XzGetAbort( HXCEEDZIP hZip )

void XzSetAbort( HXCEEDZIP hZip, BOOL bValue )

Applicable methods

All methods except AddFilesToProcess and AddFilesToExclude

Related topics

To find out what the current operation being executed is, use the CurrentOperation property.