L_Doc2CleanupPages

Show in webframe

#include "ltdoc2.h"

L_LTDOC2_API L_INT EXT_FUNCTION L_Doc2CleanupPages(hDoc, bAutoCleanup)

L_HDOC2 hDoc;	/* handle to the OCR document */
L_BOOL bAutoCleanup;	/* flag to control the cleaning-up behavior */

Enables or disables the automatic cleaning up of pages.

Parameter	Description
hDoc	Handle to the OCR document.
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

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

LTDOC2

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Functions:	L_Doc2AddPage, L_Doc2GetPageCount, L_Doc2UpdatePage, L_Doc2ExportPage, L_Doc2GetPageInfo, L_Doc2RemovePage, L_Doc2ShutDown
Topics:	Working with Pages
	OCR Functions: Pages