L_Doc2CleanupPages

#include "ltdoc2.h"

L_LTDOC2_API L_INT EXT_FUNCTION L_Doc2CleanupPages(hDoc, bAutoCleanup)

Enables or disables the automatic cleaning up of pages.

Parameters

L_HDOC2 hDoc

Handle to the OCR document.

L_BOOL bAutoCleanup

Flag that indicates whether to enable or disable automatic cleanup of temporary files. Possible values are:

Value Meaning
TRUE Enable the automatic cleaning-up temporary files, when a page is removed from the OCR document by calling the L_Doc2RemovePage function It will also check for any files left over from previous page removals and will delete them as well. This happens if previously the function has been called with its bAutoCleanup parameter set to FALSE prior to calling the L_Doc2RemovePage function. This is the default value.
FALSE Disable the automatic cleanup of temporary files.

Returns

Value Meaning
SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.

Comments

When this function is called with TRUE passed to the bAutoCleanup parameter, when L_Doc2RemovePage is called it will delete the specified page from the OCR document in the engine and also delete its corresponding temporary file.

When this function is called with FALSE passed to the bAutoCleanup parameter, when L_Doc2RemovePage is called it will delete the specified page from the OCR document in the engine but not its corresponding temporary file. In this case, the corresponding temporary file will be deleted either by calling this function again, passing TRUE to the bAutoCleanup parameter or by shutting down the OCR engine by calling the L_Doc2ShutDown function.

Required DLLs and Libraries

Help Version 21.0.2021.4.7
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS OCR Module - OmniPage Engine C API Help