ZipUnPack

Member of namespace

Convert

Syntax

bool ZipUnPack ()

Parameters

None.

Returns

True, if the contents of the compressed file is successfully extracted.

False, if the current page is not a PDF or if there is a failure in the extraction.

If the number of input files/pages exceeds the maximum that is allowed or if there is a failure in the extraction, the batch is set to abort.

Level

Page level.

Details

If the current page is compressed, the files that are contained in the archive are placed into the current batch directory. Each new file also has a new page that is created within the application environment that can be processed by subsequent rules. The original file name from which the page was extracted is stored in the ParentImage variable, for future reference within your application.

Example:

ChkDCOStatus("49")
ZipUnPack()
SetDCOStatus("75")       

In this example, the action checks if the current page is the type, Other, and tries to extract the page. If the extraction is successful, then the current page was a valid compressed file. The files are extracted from the compressed file and put in the batch directory. The next action sets the page status of the compressed file to Deleted. The action does not delete it from the batch, but stops further processing of the compressed file.